Developer Guide

Contributor-oriented development guide for Knowns.

Source fileb4192f7Updated Jun 26, 2026, 7:11 AM

Developer Guide

Start here if you are contributing to Knowns.

Read first

  1. README.md
  2. docs/en/README.md
  3. MCP initial and on-demand help output when working through an AI assistant

Important directories

  • internal/cli/
  • internal/mcp/handlers/
  • internal/search/
  • internal/runtimeinstall/
  • internal/codegen/
  • internal/storage/
  • tests/
  • ui/

Useful commands

bash
go build -o ./bin/knowns ./cmd/knowns
go test ./...
go test ./internal/cli -count=1
go test ./tests -count=1

Working rule of thumb

When behavior changes, keep code, tests, and docs aligned in the same pass whenever possible.