Documentation
Public documentation for Knowns CLI.
Knowns Documentation
Knowns is a project context layer for software teams and AI agents. It gives a repository one shared place for tasks, docs, memory, templates, semantic search, and AI integrations.
Use these docs if you want to:
- set up Knowns in an existing repository
- keep project work, decisions, and docs readable by both humans and AI
- connect assistants through MCP, skills, or lightweight shim files
- use the Web UI for boards, docs, graph views, and chat workflows
Core ideas
- Task: planned work with status, acceptance criteria, notes, and links to context.
- Doc: durable project knowledge such as architecture, specs, decisions, or onboarding material.
- Memory: short reusable context that should be recalled later, such as conventions or preferences.
- Template: reusable project scaffolding for repeated code or document patterns.
- Search / retrieval: local context lookup that connects tasks, docs, memory, and code references.
- MCP and skills: AI integration surfaces. MCP exposes structured tools; skills are agent-side workflow commands such as
/kn-*in Claude or$kn-*in Codex.
Recommended reading order
- Installation
- Quick start
- First project
- Why Knowns exists
- User guide
- Task Management
- AI Agent Guide
- AI Workflow
Which page should I read first?
- New user: start with Installation, then Quick start.
- Existing project owner: read First project, then Workflow.
- AI assistant user: read AI Workflow, MCP integration, and Skills.
- CLI reference lookup: go directly to Commands.
Structure
getting-started/- installation and first-run docs
guides/- practical usage guides
reference/- command and config reference
integrations/- platform, MCP, skills, templates, sync, and compatibility
contributing/- contributor-oriented notes
Index
Getting started
Guides
- Why Knowns exists
- User guide
- Task Management
- AI Agent Guide
- AI Workflow
- Memory System
- Workflow
- Web UI
- MCP integration
Reference
Integrations
Contributing
Tài liệu Knowns
Knowns là một project context layer cho software team và AI agent. Nó gom task, doc, memory, template, semantic search, và AI integrations vào cùng một repo-local system để người và AI cùng làm việc trên một nguồn context thống nhất.
Dùng bộ docs này khi bạn muốn:
- setup Knowns trong một repository có sẵn
- giữ project work, decision, và doc ở nơi cả người lẫn AI đều đọc được
- kết nối assistant qua MCP, skill, hoặc lightweight shim files
- dùng Web UI để xem board, doc, graph, và chat workflows
Nội dung tiếng Việt bám theo docs/en/ nhưng viết lại cho dễ đọc với developer Việt. Các feature name như task, doc, memory, template, search, MCP, skill, Web UI được giữ nguyên để khớp với CLI và UI.
Khái niệm chính
- Task: phần work đã được lên kế hoạch, có status, acceptance criteria, notes, và context links.
- Doc: project knowledge bền vững như architecture, spec, decision, hoặc onboarding.
- Memory: context ngắn, có thể dùng lại về sau, ví dụ convention hoặc preference.
- Template: scaffolding có thể tái sử dụng cho code hoặc doc pattern lặp lại.
- Search / retrieval: cách tìm context local từ task, doc, memory, và code references.
- MCP và skill: bề mặt tích hợp AI. MCP expose structured tools; skill là workflow command phía agent, ví dụ
/kn-*trong Claude hoặc$kn-*trong Codex.
Bắt đầu từ đâu?
- Cài đặt
- Quick start
- Dự án đầu tiên
- Vì sao có Knowns?
- Hướng dẫn sử dụng
- Quản lý task
- Làm việc với AI
- AI workflow
Nên đọc trang nào trước?
- Người mới: đọc Cài đặt, rồi Quick start.
- Project owner: đọc Dự án đầu tiên, rồi Workflow.
- Người dùng AI assistant: đọc AI workflow, MCP, và Skills.
- Muốn tra cứu CLI: vào thẳng Lệnh.
Cấu trúc
getting-started/— cài đặt và chạy lần đầuguides/— hướng dẫn theo tình huống thực tếreference/— tra cứu lệnh, config, cơ chế tham chiếuintegrations/— platform, MCP, skills, templates, sync, tương thíchcontributing/— cho người muốn đóng góp
Mục lục
Bắt đầu
Hướng dẫn
- Vì sao có Knowns?
- Hướng dẫn sử dụng
- Quản lý task
- Làm việc với AI
- AI workflow
- Memory
- Workflow
- Web UI
- MCP