know-cli 0.3.6__tar.gz → 0.3.7__tar.gz
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.
- {know_cli-0.3.6 → know_cli-0.3.7}/PKG-INFO +1 -1
- know_cli-0.3.7/docs/arc.md +43 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/docs/architecture.md +58 -45
- {know_cli-0.3.6 → know_cli-0.3.7}/pyproject.toml +1 -1
- {know_cli-0.3.6 → know_cli-0.3.7}/src/know/lexical_index.py +2 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/src/know/semantic_search.py +3 -3
- know_cli-0.3.6/docs/arc.md +0 -38
- {know_cli-0.3.6 → know_cli-0.3.7}/.github/actions/know-cli/action.yml +0 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/.github/workflows/example-advanced.yml +0 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/.github/workflows/example-basic.yml +0 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/.gitignore +0 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/AGENTS.md +0 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/KNOW_SKILL.md +0 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/README.md +0 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/docs/IMPLEMENTATION_PLAN.md +0 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/docs/IMPROVEMENTS.md +0 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/docs/STRATEGIC_AUDIT.md +0 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/docs/architecture-diff.md +0 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/docs/dependencies.md +0 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/docs/digest-compact.md +0 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/docs/digest-llm.md +0 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/docs/onboarding-new-devs.md +0 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/docs/onboarding-new_devs.md +0 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/src/know/__init__.py +0 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/src/know/ai.py +0 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/src/know/cli.py +0 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/src/know/config.py +0 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/src/know/context_engine.py +0 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/src/know/cost.py +0 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/src/know/diff.py +0 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/src/know/exceptions.py +0 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/src/know/generator.py +0 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/src/know/git_hooks.py +0 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/src/know/history.py +0 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/src/know/import_graph.py +0 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/src/know/index.py +0 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/src/know/knowledge_base.py +0 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/src/know/logger.py +0 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/src/know/mcp_server.py +0 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/src/know/models.py +0 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/src/know/parsers.py +0 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/src/know/quality.py +0 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/src/know/scanner.py +0 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/src/know/state.py +0 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/src/know/stats.py +0 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/src/know/token_counter.py +0 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/src/know/tools.py +0 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/src/know/watcher.py +0 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/tests/README.md +0 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/tests/conftest.py +0 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/tests/mcp_stub/mcp/__init__.py +0 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/tests/mcp_stub/mcp/server/__init__.py +0 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/tests/mcp_stub/mcp/server/fastmcp.py +0 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/tests/test_efficiency.py +0 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/tests/test_history_cost.py +0 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/tests/test_know.py +0 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/tests/test_search_hybrid.py +0 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/tests/test_state.py +0 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/tests/test_unit.py +0 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/tests/test_week2.py +0 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/tests/test_week3.py +0 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/tests/test_week4.py +0 -0
- {know_cli-0.3.6 → know_cli-0.3.7}/tests/test_week6_tools.py +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: know-cli
|
|
3
|
-
Version: 0.3.
|
|
3
|
+
Version: 0.3.7
|
|
4
4
|
Summary: Context Intelligence for AI Coding Agents — smart, token-budgeted code context
|
|
5
5
|
Project-URL: Homepage, https://github.com/vic/know-cli
|
|
6
6
|
Project-URL: Repository, https://github.com/vic/know-cli
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# know-cli
|
|
2
|
+
|
|
3
|
+
**Description:**
|
|
4
|
+
|
|
5
|
+
know-cli is a command-line interface tool designed to help users quickly access and manage knowledge bases from the terminal. It streamlines the process of storing, retrieving, and organizing information without leaving your command line environment. Whether you're documenting project notes, technical references, or quick facts, know-cli makes knowledge management fast and efficient.
|
|
6
|
+
|
|
7
|
+
**Features:**
|
|
8
|
+
|
|
9
|
+
- **Quick Search & Retrieval** – Instantly find and display stored knowledge entries with powerful search capabilities
|
|
10
|
+
- **Easy Organization** – Create, update, and categorize your knowledge base with intuitive commands
|
|
11
|
+
- **Lightweight & Fast** – Minimal dependencies and optimized performance for seamless terminal integration
|
|
12
|
+
|
|
13
|
+
## 📁 Project Structure
|
|
14
|
+
|
|
15
|
+
- **[src.know.index](src/know/index.py)** - Index management for incremental code scanning.
|
|
16
|
+
- **[src.know.ai](src/know/ai.py)** - AI integration for intelligent code understanding with advanced token optimization.
|
|
17
|
+
- **[src.know.lexical_index](src/know/lexical_index.py)** - SQLite FTS5 index for chunk-level lexical search.
|
|
18
|
+
- **[src.know.stats](src/know/stats.py)** - Usage statistics tracker for know-cli.
|
|
19
|
+
- **[src.know.history](src/know/history.py)** - Execution history tracking for know-cli.
|
|
20
|
+
- **[src.know.models](src/know/models.py)** - Data models for know-cli.
|
|
21
|
+
- **[src.know.watcher](src/know/watcher.py)** - File system watcher for auto-updating documentation.
|
|
22
|
+
- **[src.know.quality](src/know/quality.py)** - Code quality metrics and dashboard.
|
|
23
|
+
- **[src.know.mcp_server](src/know/mcp_server.py)** - MCP (Model Context Protocol) server for know-cli.
|
|
24
|
+
- **[src.know.exceptions](src/know/exceptions.py)** - Custom exceptions for know-cli.
|
|
25
|
+
- **[src.know.logger](src/know/logger.py)** - Logging configuration for know.
|
|
26
|
+
- **[src.know.generator](src/know/generator.py)** - Documentation generator.
|
|
27
|
+
- **[src.know.parsers](src/know/parsers.py)** - Parser strategy pattern for language-specific parsing.
|
|
28
|
+
- **[src.know.cli](src/know/cli.py)** - CLI entry point for know.
|
|
29
|
+
- **[src.know.semantic_search](src/know/semantic_search.py)** - Semantic code search using real embeddings and vector similarity.
|
|
30
|
+
- ... and 12 more modules
|
|
31
|
+
|
|
32
|
+
## 📊 Statistics
|
|
33
|
+
|
|
34
|
+
- **Files:** 27
|
|
35
|
+
- **Modules:** 27
|
|
36
|
+
- **Functions:** 80
|
|
37
|
+
- **Classes:** 52
|
|
38
|
+
|
|
39
|
+
---
|
|
40
|
+
|
|
41
|
+
*Generated by [know](https://github.com/sushilk1991/know-cli) v1.0.0*
|
|
42
|
+
|
|
43
|
+
Run `know update` to refresh this documentation.
|
|
@@ -2,51 +2,41 @@
|
|
|
2
2
|
|
|
3
3
|
```mermaid
|
|
4
4
|
graph TB
|
|
5
|
-
|
|
6
|
-
token_counter["token_counter\n(3f, 0c)"]
|
|
7
|
-
semantic_search["semantic_search\n(0f, 2c)"]
|
|
5
|
+
index["index\n(1f, 1c)"]
|
|
8
6
|
ai["ai\n(0f, 4c)"]
|
|
9
|
-
|
|
10
|
-
watcher["watcher\n(0f, 2c)"]
|
|
11
|
-
cli["cli\n(33f, 0c)"]
|
|
7
|
+
lexical_index["lexical_index\n(0f, 2c)"]
|
|
12
8
|
stats["stats\n(0f, 1c)"]
|
|
9
|
+
history["history\n(0f, 2c)"]
|
|
10
|
+
models["models\n(0f, 4c)"]
|
|
11
|
+
watcher["watcher\n(0f, 2c)"]
|
|
12
|
+
quality["quality\n(0f, 2c)"]
|
|
13
13
|
mcp_server["mcp_server\n(5f, 0c)"]
|
|
14
14
|
exceptions["exceptions\n(0f, 8c)"]
|
|
15
|
-
|
|
15
|
+
logger["logger\n(2f, 0c)"]
|
|
16
16
|
generator["generator\n(0f, 1c)"]
|
|
17
17
|
parsers["parsers\n(0f, 5c)"]
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
config["config\n(1f, 6c)"]
|
|
22
|
-
__init__["__init__"]
|
|
23
|
-
models["models\n(0f, 4c)"]
|
|
18
|
+
cli["cli\n(58f, 0c)"]
|
|
19
|
+
semantic_search["semantic_search\n(2f, 2c)"]
|
|
20
|
+
__init__["__init__\n(1f, 0c)"]
|
|
24
21
|
scanner["scanner\n(1f, 1c)"]
|
|
22
|
+
token_counter["token_counter\n(3f, 0c)"]
|
|
23
|
+
state["state\n(0f, 1c)"]
|
|
24
|
+
knowledge_base["knowledge_base\n(0f, 2c)"]
|
|
25
25
|
|
|
26
|
-
|
|
26
|
+
index --> exceptions
|
|
27
|
+
index --> logger
|
|
28
|
+
index --> config
|
|
29
|
+
index --> scanner
|
|
30
|
+
index --> context_engine
|
|
27
31
|
ai --> config
|
|
28
|
-
|
|
29
|
-
|
|
32
|
+
lexical_index --> logger
|
|
33
|
+
lexical_index --> context_engine
|
|
34
|
+
stats --> logger
|
|
35
|
+
stats --> config
|
|
36
|
+
history --> config
|
|
30
37
|
watcher --> config
|
|
31
38
|
watcher --> scanner
|
|
32
39
|
watcher --> generator
|
|
33
|
-
cli --> config
|
|
34
|
-
cli --> scanner
|
|
35
|
-
cli --> generator
|
|
36
|
-
cli --> watcher
|
|
37
|
-
cli --> ai
|
|
38
|
-
cli --> git_hooks
|
|
39
|
-
cli --> logger
|
|
40
|
-
cli --> exceptions
|
|
41
|
-
cli --> semantic_search
|
|
42
|
-
cli --> context_engine
|
|
43
|
-
cli --> import_graph
|
|
44
|
-
cli --> diff
|
|
45
|
-
cli --> knowledge_base
|
|
46
|
-
cli --> stats
|
|
47
|
-
cli --> mcp_server
|
|
48
|
-
stats --> logger
|
|
49
|
-
stats --> config
|
|
50
40
|
mcp_server --> logger
|
|
51
41
|
mcp_server --> config
|
|
52
42
|
mcp_server --> context_engine
|
|
@@ -56,19 +46,34 @@ graph TB
|
|
|
56
46
|
mcp_server --> ai
|
|
57
47
|
mcp_server --> import_graph
|
|
58
48
|
mcp_server --> stats
|
|
59
|
-
diff --> config
|
|
60
|
-
diff --> scanner
|
|
61
49
|
generator --> config
|
|
62
50
|
generator --> scanner
|
|
63
51
|
generator --> ai
|
|
64
52
|
parsers --> exceptions
|
|
65
53
|
parsers --> models
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
54
|
+
cli --> config
|
|
55
|
+
cli --> scanner
|
|
56
|
+
cli --> generator
|
|
57
|
+
cli --> watcher
|
|
58
|
+
cli --> ai
|
|
59
|
+
cli --> git_hooks
|
|
60
|
+
cli --> logger
|
|
61
|
+
cli --> exceptions
|
|
62
|
+
cli --> context_engine
|
|
63
|
+
cli --> import_graph
|
|
64
|
+
cli --> diff
|
|
65
|
+
cli --> knowledge_base
|
|
66
|
+
cli --> stats
|
|
67
|
+
cli --> state
|
|
68
|
+
cli --> tools
|
|
69
|
+
cli --> history
|
|
70
|
+
cli --> cost
|
|
71
|
+
cli --> semantic_search
|
|
72
|
+
cli --> mcp_server
|
|
73
|
+
semantic_search --> context_engine
|
|
74
|
+
semantic_search --> lexical_index
|
|
75
|
+
semantic_search --> config
|
|
76
|
+
semantic_search --> scanner
|
|
72
77
|
__init__ --> cli
|
|
73
78
|
scanner --> exceptions
|
|
74
79
|
scanner --> logger
|
|
@@ -76,13 +81,21 @@ graph TB
|
|
|
76
81
|
scanner --> models
|
|
77
82
|
scanner --> config
|
|
78
83
|
scanner --> index
|
|
84
|
+
state --> config
|
|
79
85
|
knowledge_base --> logger
|
|
80
86
|
knowledge_base --> config
|
|
81
87
|
knowledge_base --> token_counter
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
88
|
+
import_graph --> logger
|
|
89
|
+
import_graph --> config
|
|
90
|
+
git_hooks --> config
|
|
91
|
+
diff --> config
|
|
92
|
+
diff --> scanner
|
|
93
|
+
cost --> config
|
|
94
|
+
context_engine --> token_counter
|
|
95
|
+
context_engine --> logger
|
|
96
|
+
context_engine --> config
|
|
97
|
+
context_engine --> scanner
|
|
98
|
+
context_engine --> import_graph
|
|
86
99
|
```
|
|
87
100
|
|
|
88
101
|
*Generated by know*
|
|
@@ -395,7 +395,7 @@ class SemanticSearcher:
|
|
|
395
395
|
def index_directory(self, root: Path, extensions: List[str] = None) -> int:
|
|
396
396
|
"""Index all files in a directory. Returns count of indexed files."""
|
|
397
397
|
if extensions is None:
|
|
398
|
-
extensions = [".py", ".ts", ".tsx", ".js", ".jsx", ".go", ".rs", ".java", ".cpp", ".c", ".h"]
|
|
398
|
+
extensions = [".py", ".ts", ".tsx", ".js", ".jsx", ".css", ".scss", ".go", ".rs", ".java", ".cpp", ".c", ".h"]
|
|
399
399
|
|
|
400
400
|
# Load .gitignore if present
|
|
401
401
|
ignore_spec = None
|
|
@@ -688,7 +688,7 @@ class SemanticSearcher:
|
|
|
688
688
|
|
|
689
689
|
q = query.strip().lower()
|
|
690
690
|
q_tokens = [t for t in re.findall(r"[a-z0-9_]+", q) if len(t) >= 3]
|
|
691
|
-
exts = {".py", ".ts", ".tsx", ".js", ".jsx", ".go", ".rs", ".java", ".cpp", ".c", ".h", ".md"}
|
|
691
|
+
exts = {".py", ".ts", ".tsx", ".js", ".jsx", ".css", ".scss", ".go", ".rs", ".java", ".cpp", ".c", ".h", ".md"}
|
|
692
692
|
fallback = []
|
|
693
693
|
for p in root.rglob("*"):
|
|
694
694
|
if not p.is_file() or p.suffix.lower() not in exts:
|
|
@@ -765,7 +765,7 @@ class SemanticSearcher:
|
|
|
765
765
|
from know.context_engine import extract_chunks_from_file
|
|
766
766
|
|
|
767
767
|
if extensions is None:
|
|
768
|
-
extensions = [".py", ".ts", ".tsx", ".js", ".jsx", ".go", ".rs", ".java", ".cpp", ".c", ".h"]
|
|
768
|
+
extensions = [".py", ".ts", ".tsx", ".js", ".jsx", ".css", ".scss", ".go", ".rs", ".java", ".cpp", ".c", ".h"]
|
|
769
769
|
|
|
770
770
|
ignore_spec = None
|
|
771
771
|
gitignore_path = root / ".gitignore"
|
know_cli-0.3.6/docs/arc.md
DELETED
|
@@ -1,38 +0,0 @@
|
|
|
1
|
-
# know-cli
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
*Generated by [know](https://github.com/sushilk1991/know-cli)*
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
## 📁 Project Structure
|
|
9
|
-
|
|
10
|
-
- **[src.know.logger](src/know/logger.py)** - Logging configuration for know.
|
|
11
|
-
- **[src.know.token_counter](src/know/token_counter.py)** - Token counting for context budget management.
|
|
12
|
-
- **[src.know.semantic_search](src/know/semantic_search.py)** - Semantic code search using real embeddings and vector similarity.
|
|
13
|
-
- **[src.know.ai](src/know/ai.py)** - AI integration for intelligent code understanding with advanced token optimization.
|
|
14
|
-
- **[src.know.import_graph](src/know/import_graph.py)** - Import graph: tracks dependencies between project modules.
|
|
15
|
-
- **[src.know.watcher](src/know/watcher.py)** - File system watcher for auto-updating documentation.
|
|
16
|
-
- **[src.know.cli](src/know/cli.py)** - CLI entry point for know.
|
|
17
|
-
- **[src.know.stats](src/know/stats.py)** - Usage statistics tracker for know-cli.
|
|
18
|
-
- **[src.know.mcp_server](src/know/mcp_server.py)** - MCP (Model Context Protocol) server for know-cli.
|
|
19
|
-
- **[src.know.exceptions](src/know/exceptions.py)** - Custom exceptions for know-cli.
|
|
20
|
-
- **[src.know.diff](src/know/diff.py)** - Diff mode for tracking architectural changes safely using git worktrees.
|
|
21
|
-
- **[src.know.generator](src/know/generator.py)** - Documentation generator.
|
|
22
|
-
- **[src.know.parsers](src/know/parsers.py)** - Parser strategy pattern for language-specific parsing.
|
|
23
|
-
- **[src.know.quality](src/know/quality.py)** - Code quality metrics and dashboard.
|
|
24
|
-
- **[src.know.git_hooks](src/know/git_hooks.py)** - Git hook management.
|
|
25
|
-
- ... and 7 more modules
|
|
26
|
-
|
|
27
|
-
## 📊 Statistics
|
|
28
|
-
|
|
29
|
-
- **Files:** 22
|
|
30
|
-
- **Modules:** 22
|
|
31
|
-
- **Functions:** 52
|
|
32
|
-
- **Classes:** 44
|
|
33
|
-
|
|
34
|
-
---
|
|
35
|
-
|
|
36
|
-
*Generated by [know](https://github.com/sushilk1991/know-cli) v1.0.0*
|
|
37
|
-
|
|
38
|
-
Run `know update` to refresh this documentation.
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|