First Project
Set up Knowns in a real repository.
First Project
After knowns init, your first goal is to add enough context that a person or AI assistant can understand the project without a long chat history. A good first setup usually includes four things:
- create a task
- create one or two documents
- confirm search works
- connect the AI runtime(s) you actually use
Example session
This example creates an authentication task because it has a clear scope and testable acceptance criteria. Replace the title and descriptions with work that matches your repository.
knowns task create "Add authentication" \
-d "JWT-based auth with login and register endpoints" \
--ac "User can register with email/password" \
--ac "User can login and receive JWT token"
knowns doc create "Auth Architecture" \
-d "Authentication design decisions" \
-f architecture
knowns search "authentication" --plain
knowns validate --plain
knowns browser --open
If you want an AI assistant to use the same project context, run setup for your platform:
knowns setup codex --global
# or:
knowns setup claude --global
--global is recommended for personal assistant setup because it updates user-level MCP config, skills, and runtime hooks. Use non-global setup only when you intentionally want repo-local integration files.
Why these steps matter
- the task gives people and AI a concrete execution target
- acceptance criteria make "done" testable
- the doc gives AI structured context instead of ad-hoc chat explanations
- search confirms local retrieval is working
- validation checks that the basic project structure is sound
- setup connects generated guidance, MCP config, and skills to the assistant you actually use
What to add next
- Add one architecture doc for the most important subsystem.
- Add one task for the next real change you plan to make.
- Add memory only for short decisions or conventions that should be recalled later.
- Run
knowns validate --plainbefore treating the project setup as complete.
Suggested next reads
Dự án đầu tiên
Sau knowns init, mục tiêu đầu tiên là thêm đủ context để một người hoặc AI assistant hiểu project mà không cần một chat history dài. Một setup đầu tiên thường gồm 4 việc:
- tạo task
- tạo 1-2 doc
- kiểm tra search hoạt động
- kết nối AI runtime đang dùng
Ví dụ
Ví dụ này tạo auth task vì scope rõ và acceptance criteria dễ kiểm tra. Hãy thay title và description bằng work thật trong repository của bạn.
knowns task create "Add authentication" \
-d "JWT-based auth with login and register endpoints" \
--ac "User can register with email/password" \
--ac "User can login and receive JWT token"
knowns doc create "Auth Architecture" \
-d "Authentication design decisions" \
-f architecture
knowns search "authentication" --plain
knowns validate --plain
knowns browser --open
Nếu muốn AI assistant dùng cùng project context, chạy setup cho platform của bạn:
knowns setup codex --global
# hoặc:
knowns setup claude --global
Dùng --global cho personal assistant setup vì nó update user-level MCP config, skills, và runtime hooks. Chỉ dùng setup không có --global khi bạn chủ ý muốn repo-local integration files.
Tại sao?
- Task cho người và AI mục tiêu cụ thể
- Acceptance criteria biến "done" thành thứ kiểm tra được
- Doc cho AI context có cấu trúc thay vì giải thích rời rạc trong chat
- Search xác nhận retrieval đang chạy
- Validate kiểm tra cấu trúc project cơ bản
- Setup kết nối generated guidance, MCP config, và skill với assistant bạn thật sự dùng
Nên thêm gì tiếp?
- Thêm một architecture doc cho subsystem quan trọng nhất.
- Thêm một task cho thay đổi thật tiếp theo bạn định làm.
- Chỉ thêm memory cho decision hoặc convention ngắn cần recall về sau.
- Chạy
knowns validate --plaintrước khi xem project setup là xong.