feat: Revise README for installation and CLI usage #1463
Conversation
Updated installation instructions and usage examples in README.
Please make sure all the checkboxes are checked:
|
WalkthroughDocumentation-only updates to README.md: restructured installation and usage content, replaced pip guidance with uv-based commands, added self-hosted and hosted platform sections, updated CLI/CLI-UI examples to use Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
README.md (2)
119-119: Tighten grammar for clarity-To use different LLM providers, for more info check out our <a href="https://docs.cognee.ai/setup-configuration/llm-providers">documentation</a> +To use different LLM providers, check out our <a href="https://docs.cognee.ai/setup-configuration/llm-providers">documentation</a> for more info.
172-174: Add language to example output block (MD040)-``` +```text Cognee turns documents into AI memory.</blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used**: CodeRabbit UI **Review profile**: CHILL **Plan**: Pro <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between 384af0fff261c3213b1e60e924d80489b6f35135 and 7620f46820955e42bdbeffb351c2259f7901e342. </details> <details> <summary>📒 Files selected for processing (1)</summary> * `README.md` (5 hunks) </details> <details> <summary>🧰 Additional context used</summary> <details> <summary>🪛 markdownlint-cli2 (0.18.1)</summary> <details> <summary>README.md</summary> 129-129: Fenced code blocks should have a language specified (MD040, fenced-code-language) </details> </details> </details> <details> <summary>⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)</summary> * GitHub Check: CLI Tests / CLI Integration Tests * GitHub Check: CLI Tests / CLI Functionality Tests * GitHub Check: Basic Tests / Run Unit Tests * GitHub Check: End-to-End Tests / Test permissions with different situations in Cognee </details> <details> <summary>🔇 Additional comments (5)</summary><blockquote> <details> <summary>README.md (5)</summary><blockquote> `148-160`: **Verified async API exports**: add, cognify, memify, and search are defined as async functions and correctly exported by the top-level cognee module. --- `192-192`: **Use inline code formatting and update the UI flag to `-ui`** ```diff -Try cognee UI by setting your LLM_API_KEY and running ``` cognee-cli -ui ``` command on your terminal. +Try cognee UI by setting your LLM_API_KEY and running `cognee-cli -ui` command on your terminal.
98-98: Verify README’s Python version support Confirm that the supported versions (3.10–3.12) in README.md align with python_requires (in pyproject.toml/setup.cfg/setup.py) and your GitHub Actions test matrix; update any discrepancies.
125-137: Add bash fence and refine CLI description-#### Via CLI +#### Via CLI -These commands will show you the basics of cognee CLI +These commands show the basics of the Cognee CLI. -``` +```bash cognee-cli add "Cognee turns documents into AI memory." cognee-cli cognify cognee-cli search "What does cognee do?" cognee-cli delete --allCommands `add`, `cognify`, `search`, `delete` confirmed. --- `100-106`: **Add language to fenced code and verify CLI entry point** ```diff -``` +```bash uv pip install cogneeNo `console_scripts` or `[tool.poetry.scripts]` found in any packaging manifest (e.g. pyproject.toml, setup.cfg, setup.py under cognee/modules/engine/operations). Confirm that installing `cognee` exposes a `cognee-cli` entry point. </blockquote></details> </blockquote></details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
Added section on using Cognee and installation instructions.
Removed contributors section from README.
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (5)
README.md (5)
101-106: Align install wording with the example (uv) or add other managersThe text says pip/poetry/uv are supported, but only uv is shown. Rephrase to avoid confusion or add examples for pip/poetry.
Apply this diff to rephrase:
-You can install Cognee using either **pip**, **poetry**, **uv** or any other python package manager. +You can install Cognee using **uv** (recommended). For pip/poetry instructions, see the docs below.
117-125: Add language to code fence and fix placeholder tokenSpecify the language for linting (MD040) and use an underscore placeholder without spaces.
-``` +```python import os os.environ["LLM_API_KEY"] = "YOUR OPENAI_API_KEY"Optionally, prefer a generic placeholder: ```diff -os.environ["LLM_API_KEY"] = "YOUR OPENAI_API_KEY" +os.environ["LLM_API_KEY"] = "YOUR_LLM_API_KEY"
134-142: Add language to fenced code block (markdownlint MD040) and tiny grammar tweakAdd bash for syntax highlighting. Also, “the cognee CLI” reads a bit smoother.
-``` +```bash cognee-cli add "Cognee turns documents into AI memory." cognee-cli cognify cognee-cli search "What does cognee do?" cognee-cli delete --all-or run
+or run--- `179-183`: **Specify language for example output** Add a language identifier to satisfy MD040 and improve readability. ```diff -``` +```text Cognee turns documents into AI memory.--- `90-96`: **Minor heading polish** Use title case for brand consistency. ```diff -## Using cognee +## Using Cognee
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(5 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
README.md
134-134: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
144-144: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (9)
- GitHub Check: CLI Tests / CLI Functionality Tests
- GitHub Check: CLI Tests / CLI Integration Tests
- GitHub Check: Basic Tests / Run Unit Tests
- GitHub Check: Basic Tests / Run Simple Examples BAML
- GitHub Check: End-to-End Tests / Deduplication Test
- GitHub Check: End-to-End Tests / Test permissions with different situations in Cognee
- GitHub Check: End-to-End Tests / Run Telemetry Pipeline Test
- GitHub Check: End-to-End Tests / S3 Bucket Test
- GitHub Check: End-to-End Tests / Server Start Test
🔇 Additional comments (4)
README.md (4)
148-169: Python example looks solidNice end-to-end flow: add → cognify → memify → search. Async usage and comments are clear.
225-239: Citation section LGTMClear and correctly formatted BibTeX with language tag.
144-146: Add bash highlighting and confirm UI flag spelling-``` +```bash cognee-cli -uiRun `cognee-cli --help` to verify whether the correct flag is `--ui` (long form) or `-ui`. --- `103-103`: **Verify the declared Python support range (3.10–3.12)** Ensure README.md’s “Python 3.10 to 3.12” matches your packaging metadata (pyproject.toml’s `requires-python` and any trove classifiers in setup.cfg/setup.py). </blockquote></details> </blockquote></details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
Clarified instructions for using the self-hosted package and deployment.
Expanded the 'Using cognee' section with details on self-hosted package and production readiness.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (6)
README.md (6)
117-121: Add language to fenced code block and fix placeholderSpecify the language and use a conventional placeholder for the API key.
-``` -import os -os.environ["LLM_API_KEY"] = "YOUR OPENAI_API_KEY" - -``` +```python +import os +os.environ["LLM_API_KEY"] = "YOUR_OPENAI_API_KEY" +```
123-125: Polish wording and link punctuationArticle usage and punctuation tweaks improve clarity.
-You can also set the variables by creating .env file, using our <a href="https://github.com/topoteretes/cognee/blob/main/.env.template">template.</a> -To use different LLM providers, for more info check out our <a href="https://docs.cognee.ai/setup-configuration/llm-providers">documentation</a> +You can also set the variables by creating a .env file, using our <a href="https://github.com/topoteretes/cognee/blob/main/.env.template">template</a>. +To use different LLM providers, check out our <a href="https://docs.cognee.ai/setup-configuration/llm-providers">documentation</a> for more info.
105-112: Mention how to install uvReaders may not have uv installed.
#### With uv - +Install uv if you don't have it: https://docs.astral.sh/uv/getting-started/installation/ ```bash uv pip install cogneeDetailed instructions can be found in our docs
--- `134-142`: **Add bash language to CLI fenced code blocks (MD040)** This satisfies markdownlint and improves syntax highlighting. ```diff -``` +```bash cognee-cli add "Cognee turns documents into AI memory." cognee-cli cognify cognee-cli search "What does cognee do?" cognee-cli delete --allor run
-+bash
cognee-cli -uiAlso applies to: 144-147
90-90: Capitalize brand in headingUse “Cognee” casing consistently.
-## Using cognee +## Using Cognee
132-132: Tighten sentence and capitalize CLI name-These commands will show you the basics of cognee CLI +These commands show the basics of the Cognee CLI
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(5 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
README.md
134-134: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
144-144: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: CLI Tests / CLI Functionality Tests
- GitHub Check: CLI Tests / CLI Integration Tests
- GitHub Check: Basic Tests / Run Unit Tests
🔇 Additional comments (3)
README.md (3)
145-145: Confirm correct UI flag nameIs the flag spelled “-ui” or “--ui”? Many CLIs prefer long options with two dashes.
If it’s “--ui”, update the snippet accordingly and consider adding
cognee-cli --helpoutput in docs for discoverability.
190-196: Fix Cogwit signup link inconsistency and grammarUnify with earlier link (Line 46) and improve step wording.
-1. Sign up on [cogwit](https://www.cognee.ai) -2. Add your API key to local UI and sync your data or send your data to Cogwit API +1. Sign up on [Cogwit](https://platform.cognee.ai/) +2. Add your API key to the local UI and sync your data, or send your data to the Cogwit API
103-103: Add or update python_requires, Trove classifiers, and CI matrix to match README’s Python 3.10–3.12 support
No python_requires, classifiers, or CI workflow entries were detected—ensure your packaging metadata and test matrix reflect Python 3.10–3.12.
Updated the features and benefits of using cognee in the README.
Updated instructions for syncing data with Cogwit API.
Updated sections on self-hosted package and hosted platform.
Reorganize CLI usage section in README for clarity.
Removed announcement for Cogwit beta launch.
Updated README to reflect changes in SDK usage and links.
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
README.md (1)
107-111: Consider adding pip installation option for broader compatibility.While uv is a modern and fast package manager, many users still rely on pip. Consider adding both options for better accessibility.
Apply this diff to include both installation methods:
#### With uv ```bash uv pip install cognee
+#### With pip
+
+bash +pip install cognee +</blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used**: CodeRabbit UI **Review profile**: CHILL **Plan**: Pro <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between 311085b2f3fdbeb3ded3e2b49ee5f4ea922c7963 and 9c3fa87e5c3149647c74130aec7b1fcdfc9cb579. </details> <details> <summary>📒 Files selected for processing (1)</summary> * `README.md` (6 hunks) </details> <details> <summary>🧰 Additional context used</summary> <details> <summary>🪛 markdownlint-cli2 (0.18.1)</summary> <details> <summary>README.md</summary> 86-86: Unordered list indentation Expected: 0; Actual: 1 (MD007, ul-indent) --- 87-87: Unordered list indentation Expected: 0; Actual: 1 (MD007, ul-indent) --- 88-88: Unordered list indentation Expected: 0; Actual: 1 (MD007, ul-indent) --- 89-89: Unordered list indentation Expected: 0; Actual: 1 (MD007, ul-indent) --- 90-90: Unordered list indentation Expected: 0; Actual: 1 (MD007, ul-indent) --- 93-93: Unordered list indentation Expected: 0; Actual: 1 (MD007, ul-indent) --- 94-94: Unordered list indentation Expected: 0; Actual: 1 (MD007, ul-indent) --- 95-95: Unordered list indentation Expected: 0; Actual: 1 (MD007, ul-indent) --- 173-173: Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 183-183: Fenced code blocks should have a language specified (MD040, fenced-code-language) </details> </details> </details> <details> <summary>⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (10)</summary> * GitHub Check: End-to-End Tests / Test permissions with different situations in Cognee * GitHub Check: End-to-End Tests / S3 Bucket Test * GitHub Check: End-to-End Tests / Server Start Test * GitHub Check: End-to-End Tests / Deduplication Test * GitHub Check: End-to-End Tests / Run Telemetry Pipeline Test * GitHub Check: CLI Tests / CLI Functionality Tests * GitHub Check: CLI Tests / CLI Integration Tests * GitHub Check: Basic Tests / Run Basic Graph Tests * GitHub Check: Basic Tests / Run Unit Tests * GitHub Check: Basic Tests / Run Simple Examples BAML </details> <details> <summary>🔇 Additional comments (5)</summary><blockquote> <details> <summary>README.md (5)</summary><blockquote> `48-48`: **LGTM! Clear and concise project description.** The updated description "Build dynamic memory for Agents and replace RAG using scalable, modular ECL (Extract, Cognify, Load) pipelines" effectively communicates the project's core value proposition. --- `144-144`: **Example text aligns well with the project description.** The updated example text "Cognee turns documents into AI memory" is consistent with the project's messaging and provides a clear, understandable example for users. --- `195-196`: **Inconsistent signup link remains unfixed.** This appears to be the same issue identified in previous review comments. The link should point to `https://platform.cognee.ai/` to match the canonical signup URL mentioned earlier. Apply this diff to fix the inconsistent URL: ```diff -1. Sign up on [cogwit](https://www.cognee.ai) -2. Add your API key to local UI and sync your data to Cogwit +1. Sign up on [Cogwit](https://platform.cognee.ai/) +2. Add your API key to the local UI and sync your data to Cogwit
228-238: LGTM! Professional citation format.The addition of the BibTeX citation block provides proper academic attribution and follows standard formatting conventions. This is a valuable addition for users who want to cite the project in academic work.
149-151: Verifiedmemify()exists: Thememify()method is implemented incognee/modules/memify/memify.py, so the README example is correct.
| ## Using cognee | ||
|
|
||
| Self-hosted package: | ||
| - Get self-serve UI with embedded Python notebooks | ||
| - Add custom tasks and pipelines via Python SDK | ||
| - Get Docker images and MCP servers you can deploy | ||
| - Use distributed cognee SDK to process a TBs of your data | ||
| - Use community adapters to connect to Redis, Azure, Falkor and others | ||
|
|
||
| ## Contributing | ||
| Your contributions are at the core of making this a true open source project. Any contributions you make are **greatly appreciated**. See [`CONTRIBUTING.md`](CONTRIBUTING.md) for more information. | ||
|
|
||
| Hosted platform: | ||
| - Sync your local data to our [hosted solution](www.cognee.ai) | ||
| - Get a secure API endpoint | ||
| - We manage the UI for you | ||
|
|
There was a problem hiding this comment.
Fix unordered list indentation and improve content clarity.
The static analysis tool identified indentation issues with the unordered lists. Additionally, there's a broken link in line 93.
Apply this diff to fix the indentation and link issues:
## Using cognee
-Self-hosted package:
- - Get self-serve UI with embedded Python notebooks
- - Add custom tasks and pipelines via Python SDK
- - Get Docker images and MCP servers you can deploy
- - Use distributed cognee SDK to process a TBs of your data
- - Use community adapters to connect to Redis, Azure, Falkor and others
+Self-hosted package:
+- Get self-serve UI with embedded Python notebooks
+- Add custom tasks and pipelines via Python SDK
+- Get Docker images and MCP servers you can deploy
+- Use distributed cognee SDK to process TBs of your data
+- Use community adapters to connect to Redis, Azure, Falkor and others
-Hosted platform:
- - Sync your local data to our [hosted solution](www.cognee.ai)
- - Get a secure API endpoint
- - We manage the UI for you
+Hosted platform:
+- Sync your local data to our [hosted solution](https://www.cognee.ai)
+- Get a secure API endpoint
+- We manage the UI for you📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ## Using cognee | |
| Self-hosted package: | |
| - Get self-serve UI with embedded Python notebooks | |
| - Add custom tasks and pipelines via Python SDK | |
| - Get Docker images and MCP servers you can deploy | |
| - Use distributed cognee SDK to process a TBs of your data | |
| - Use community adapters to connect to Redis, Azure, Falkor and others | |
| ## Contributing | |
| Your contributions are at the core of making this a true open source project. Any contributions you make are **greatly appreciated**. See [`CONTRIBUTING.md`](CONTRIBUTING.md) for more information. | |
| Hosted platform: | |
| - Sync your local data to our [hosted solution](www.cognee.ai) | |
| - Get a secure API endpoint | |
| - We manage the UI for you | |
| ## Using cognee | |
| Self-hosted package: | |
| - Get self-serve UI with embedded Python notebooks | |
| - Add custom tasks and pipelines via Python SDK | |
| - Get Docker images and MCP servers you can deploy | |
| - Use distributed cognee SDK to process TBs of your data | |
| - Use community adapters to connect to Redis, Azure, Falkor and others | |
| Hosted platform: | |
| - Sync your local data to our [hosted solution](https://www.cognee.ai) | |
| - Get a secure API endpoint | |
| - We manage the UI for you |
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
86-86: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
87-87: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
88-88: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
89-89: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
90-90: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
93-93: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
94-94: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
95-95: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
🤖 Prompt for AI Agents
In README.md around lines 83 to 96, the unordered list under "Using cognee" has
inconsistent indentation and one broken link; normalize the list indentation so
each bullet is a top-level list item under its section (consistent leading
spaces or no extra indentation), fix the broken hosted solution link by adding
the proper scheme (https://www.cognee.ai), and optionally tighten copy for
clarity (e.g., "Process TBs of data" → "process terabytes of data", "MCP servers
you can deploy" → "deployable MCP servers") while keeping the same bullet
structure.
| ##### Via CLI | ||
|
|
||
| ## Our paper is out! <a href="https://arxiv.org/abs/2505.24478" target="_blank" rel="noopener noreferrer">Read here</a> | ||
| Let's get the basics covered | ||
|
|
||
| <div style="text-align: center"> | ||
| <img src="assets/cognee-paper.png" alt="cognee paper" width="100%" /> | ||
| </div> | ||
| ``` | ||
| cognee-cli add "Cognee turns documents into AI memory." | ||
| </div> | ||
| cognee-cli cognify | ||
| ## Cognee UI | ||
| cognee-cli search "What does cognee do?" | ||
| cognee-cli delete --all | ||
| You can also cognify your files and query using cognee UI. | ||
| ``` | ||
| or run | ||
| ``` | ||
| cognee-cli -ui | ||
| ``` |
There was a problem hiding this comment.
🧩 Analysis chain
Add language specification to code blocks and verify CLI command.
The markdown linter identified missing language specifications for the CLI code blocks. Also, verify that the cognee-cli command structure is correct.
Apply this diff to add language specifications:
-```
+```bash
cognee-cli add "Cognee turns documents into AI memory."
cognee-cli cognify
cognee-cli search "What does cognee do?"
cognee-cli delete --all
or run
- +bash
cognee-cli -ui
Also verify that the CLI commands are correct:
🏁 Script executed:
#!/bin/bash
# Search for CLI command definitions in the codebase
rg -n "cognee-cli" --type py
fd -t f -e py | xargs rg -l "cli" | head -5Length of output: 207
🏁 Script executed:
#!/usr/bin/env bash
# Find CLI implementation file(s)
fd 'cli\.py' -e py -t f
# Inspect entry_points for console_scripts in setup.py, setup.cfg, pyproject.toml
rg -n "console_scripts" -g "*.py" -g "setup.cfg" -g "pyproject.toml"
# List click-based commands and options
rg -nP '@click\.(group|command|option)' --type=py
# Detect Typer-based commands
rg -n "Typer" --type=py
rg -nP 'app\.command' --type=py
# Verify UI option usage
rg -n "--ui" --type=py -C2
rg -n "-ui" --type=py -C2
# Check for subcommand definitions
rg -nP '^def (add|cognify|search|delete)\(' --type=pyLength of output: 829
🏁 Script executed:
#!/usr/bin/env bash
# Show the CLI implementation to verify available commands and options
sed -n '1,200p' cognee/cli/minimal_cli.py
# Look for click or typer decorators indicating command definitions
rg -nP '@click\.(group|command|option)' cognee/cli/minimal_cli.py
rg -n 'Typer' -g 'cognee/cli/minimal_cli.py'Length of output: 3111
🏁 Script executed:
#!/usr/bin/env bash
# Inspect full CLI implementation for command definitions and options
sed -n '1,200p' cognee/cli/_cognee.py
# List all command functions
rg -nP '^def (add|cognify|search|delete|config)\(' -C2 cognee/cli/_cognee.py
# Find --all option definitions
rg -nP '@click\.option.*--all' -C2 cognee/cli/_cognee.py
# Find -ui or --ui option definitions
rg -nP '@click\.option.*(-ui|--ui)' -C2 cognee/cli/_cognee.pyLength of output: 6198
🏁 Script executed:
#!/usr/bin/env bash
# Inspect entry points in pyproject.toml or setup.cfg
rg -n "console_scripts" -g "pyproject.toml"
rg -n "scripts" -g "pyproject.toml" -C3
rg -n "entry_points" -g "pyproject.toml" -C3
# If setup.cfg exists, inspect it
if [ -f setup.cfg ]; then
sed -n '1,200p' setup.cfg
fi
# If setup.py exists, inspect for entry_points
if [ -f setup.py ]; then
sed -n '1,200p' setup.py
fiLength of output: 446
#!/usr/bin/env bash
# Locate and inspect pyproject.toml for console script definition
fd 'pyproject.toml' -t f
sed -n '1,200p' pyproject.toml
# Inspect delete command implementation for --all option
sed -n '1,200p' cognee/cli/commands/delete_command.py
rg -nP 'add_argument.*--all' -C3 cognee/cli/commands/delete_command.py🏁 Script executed:
#!/usr/bin/env bash
# Locate and inspect pyproject.toml for script definitions
fd pyproject.toml -t f
sed -n '1,200p' pyproject.toml
# Check for Poetry scripts section
rg -n '\[tool\.poetry\.scripts\]' -g pyproject.toml -C2
# Inspect setup.cfg for entry_points
fd setup.cfg -t f
sed -n '1,200p' setup.cfg
# Inspect setup.py for console_scripts
fd setup.py -t f
sed -n '1,200p' setup.pyLength of output: 353
#!/usr/bin/env bash
# Inspect delete_command implementation for --all option
sed -n '1,200p' cognee/cli/commands/delete_command.py
# Search for --all argument in delete_command
rg -nP '\b--all\b' -C2 cognee/cli/commands/delete_command.pyAdd bash fences and use correct CLI name
Wrap the snippets in ```bash and replace cognee-cli with `cognee` (the entry point prints usage as `cognee`).
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
173-173: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
183-183: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
In README.md around lines 169 to 185, the CLI examples are not fenced as bash
and use the wrong binary name; update the fenced code blocks to use ```bash (so
shells get syntax highlighting) and replace every occurrence of `cognee-cli`
with `cognee` in those snippets and the single-line example, leaving surrounding
text unchanged.
Updated installation instructions and usage examples in README.
Description
Type of Change
Screenshots/Videos (if applicable)
Pre-submission Checklist
DCO Affirmation
I affirm that all code in every commit of this pull request conforms to the terms of the Topoteretes Developer Certificate of Origin.