knowns 0.8.5 → 0.8.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (11) hide show
  1. package/README.md +34 -31
  2. package/dist/index.js +976 -394
  3. package/dist/mcp/server.js +399 -54
  4. package/dist/ui/assets/index-BANrBoru.css +1 -0
  5. package/dist/ui/assets/index-CruKONTP.js +317 -0
  6. package/dist/ui/assets/logo-BkDQ9x4a.png +0 -0
  7. package/dist/ui/index.html +4 -3
  8. package/dist/ui/logo.png +0 -0
  9. package/package.json +2 -8
  10. package/dist/ui/assets/index-BTMZF9sb.js +0 -313
  11. package/dist/ui/assets/index-CcZnlUm-.css +0 -1
package/README.md CHANGED
@@ -1,11 +1,11 @@
1
1
  <p align="center">
2
- <img src="images/cover.jpeg" alt="Knowns - Task & Documentation Management" width="100%">
2
+ <img src="images/cover.png" alt="Knowns - Task & Documentation Management" width="100%">
3
3
  </p>
4
4
 
5
5
  <h1 align="center">Knowns</h1>
6
6
 
7
7
  <p align="center">
8
- <strong>Know what your team knows.</strong>
8
+ <strong>What your AI should have knowns.</strong>
9
9
  </p>
10
10
 
11
11
  <p align="center">
@@ -57,7 +57,7 @@ knowns task create "Add login" -d "Follow @doc/patterns/auth-pattern"
57
57
 
58
58
  1. **You plan** — Create tasks with acceptance criteria in Web UI or CLI
59
59
  2. **You link** — Reference docs like `@doc/patterns/auth` in task descriptions
60
- 3. **AI executes** — Tell AI *"Work on task 42"*, it reads the task, follows the refs, and implements
60
+ 3. **AI executes** — Tell AI _"Work on task 42"_, it reads the task, follows the refs, and implements
61
61
 
62
62
  Knowns resolves `@doc/...` and `@task-...` into real files. AI reads them via [MCP](./docs/mcp-integration.md) or `--plain` output — no copy-paste needed.
63
63
 
@@ -79,27 +79,27 @@ knowns browser # Open Web UI
79
79
 
80
80
  ## Why Knowns over Notion / Jira / Obsidian?
81
81
 
82
- | | Knowns | Notion/Jira | Obsidian |
83
- |---|--------|-------------|----------|
84
- | **AI-readable** | `--plain` output, MCP server | Copy-paste manually | Plugins needed |
85
- | **File-based** | Git-friendly `.knowns/` folder | Cloud-locked | Local files |
86
- | **CLI-first** | Full CLI + Web UI | Web only | GUI only |
87
- | **Context linking** | `@doc/...` `@task-42` refs | Manual links | Wiki links |
88
- | **Source of truth** | Local files (Git-versioned) | Remote database | Local vault |
89
- | **Minimal setup** | `knowns init` and done | Complex setup | Many plugins |
82
+ | | Knowns | Notion/Jira | Obsidian |
83
+ | ------------------- | ------------------------------ | ------------------- | -------------- |
84
+ | **AI-readable** | `--plain` output, MCP server | Copy-paste manually | Plugins needed |
85
+ | **File-based** | Git-friendly `.knowns/` folder | Cloud-locked | Local files |
86
+ | **CLI-first** | Full CLI + Web UI | Web only | GUI only |
87
+ | **Context linking** | `@doc/...` `@task-42` refs | Manual links | Wiki links |
88
+ | **Source of truth** | Local files (Git-versioned) | Remote database | Local vault |
89
+ | **Minimal setup** | `knowns init` and done | Complex setup | Many plugins |
90
90
 
91
91
  **Best for:** Dev teams who pair with AI and want persistent project memory.
92
92
 
93
93
  ## Features
94
94
 
95
- | Feature | Description |
96
- |---------|-------------|
97
- | **Task Management** | Create, track tasks with acceptance criteria |
98
- | **Documentation** | Nested folders with markdown support |
99
- | **Time Tracking** | Built-in timers and reports |
100
- | **Context Linking** | `@task-42` and `@doc/patterns/auth` references |
101
- | **AI Integration** | MCP Server, `--plain` output, guideline templates |
102
- | **Web UI** | Kanban board, doc browser, dark mode |
95
+ | Feature | Description |
96
+ | ------------------- | ------------------------------------------------- |
97
+ | **Task Management** | Create, track tasks with acceptance criteria |
98
+ | **Documentation** | Nested folders with markdown support |
99
+ | **Time Tracking** | Built-in timers and reports |
100
+ | **Context Linking** | `@task-42` and `@doc/patterns/auth` references |
101
+ | **AI Integration** | MCP Server, `--plain` output, guideline templates |
102
+ | **Web UI** | Kanban board, doc browser, dark mode |
103
103
 
104
104
  ---
105
105
 
@@ -115,6 +115,9 @@ knowns task edit <id> -s in-progress -a @me
115
115
  # Documentation
116
116
  knowns doc create "Title" -d "Description" -f "folder"
117
117
  knowns doc "doc-name" --plain # View doc (shorthand)
118
+ knowns doc "doc-name" --info --plain # Check size/tokens first
119
+ knowns doc "doc-name" --toc --plain # Get table of contents
120
+ knowns doc "doc-name" --section "2" --plain # Read specific section
118
121
 
119
122
  # Time & Search
120
123
  knowns time start <id> && knowns time stop
@@ -131,17 +134,17 @@ knowns agents sync --type mcp # MCP tools format
131
134
 
132
135
  ## Documentation
133
136
 
134
- | Guide | Description |
135
- |-------|-------------|
136
- | [Command Reference](./docs/commands.md) | All CLI commands with examples |
137
- | [Workflow Guide](./docs/workflow.md) | Task lifecycle from creation to completion |
138
- | [Reference System](./docs/reference-system.md) | How `@doc/` and `@task-` linking works |
139
- | [Web UI](./docs/web-ui.md) | Kanban board and document browser |
140
- | [MCP Integration](./docs/mcp-integration.md) | Claude Desktop setup |
141
- | [Configuration](./docs/configuration.md) | Project structure and options |
142
- | [AI Workflow](./docs/ai-workflow.md) | Guide for AI agents |
143
- | [Developer Guide](./docs/developer-guide.md) | Technical docs for contributors |
144
- | [Changelog](./CHANGELOG.md) | Version history |
137
+ | Guide | Description |
138
+ | ---------------------------------------------- | ------------------------------------------ |
139
+ | [Command Reference](./docs/commands.md) | All CLI commands with examples |
140
+ | [Workflow Guide](./docs/workflow.md) | Task lifecycle from creation to completion |
141
+ | [Reference System](./docs/reference-system.md) | How `@doc/` and `@task-` linking works |
142
+ | [Web UI](./docs/web-ui.md) | Kanban board and document browser |
143
+ | [MCP Integration](./docs/mcp-integration.md) | Claude Desktop setup |
144
+ | [Configuration](./docs/configuration.md) | Project structure and options |
145
+ | [AI Workflow](./docs/ai-workflow.md) | Guide for AI agents |
146
+ | [Developer Guide](./docs/developer-guide.md) | Technical docs for contributors |
147
+ | [Changelog](./CHANGELOG.md) | Version history |
145
148
 
146
149
  ---
147
150
 
@@ -183,6 +186,6 @@ For technical details, see [Architecture](./ARCHITECTURE.md) and [Contributing](
183
186
  ---
184
187
 
185
188
  <p align="center">
186
- <strong>Know what your team knows.</strong><br>
189
+ <strong>What your AI should have knowns.</strong><br>
187
190
  Built for dev teams who pair with AI.
188
191
  </p>