docs: add more details to README on how to run cognee ui #1414
Conversation
Please make sure all the checkboxes are checked:
|
WalkthroughDocumentation update in README.md: adds a dedicated “Installation for UI” section with pip extras for API/backend dependencies, clarifies that the default install is lightweight, and introduces a “Running the UI” subsection with the corrected command “cognee-cli -ui,” fixing a prior typo. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests
Tip 👮 Agentic pre-merge checks are now available in preview!Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.
Please see the documentation for more information. Example: reviews:
pre_merge_checks:
custom_checks:
- name: "Undocumented Breaking Changes"
mode: "warning"
instructions: |
Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).Please share your feedback with us on this Discord post. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 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 (6)
README.md (6)
183-185: Offer equivalent install commands for uv/poetry.Many users follow earlier sections using uv/poetry. Add alternatives to reduce friction.
Apply:
```bash -pip install 'cognee[api]' +pip install 'cognee[api]' +# via uv +uv pip install "cognee[api]" +# via Poetry +poetry add cognee -E api--- `181-185`: **Note Windows quoting.** On Windows CMD, single quotes aren’t parsed; suggest double quotes to avoid confusion. Example text to append below the code block: Use "cognee[api]" on Windows CMD. --- `179-181`: **Capitalize product name consistently (“Cognee UI”).** Match the rest of the README styling. ```diff -### Installation for UI -To use the cognee UI with full functionality, you need to install cognee with API dependencies: +### Installation for UI +To use the Cognee UI with full functionality, install Cognee with API dependencies:
187-187: Cross-link to the main Installation section for context.Add a short pointer back to “📦 Installation” to help users who skipped it.
-The UI requires backend server functionality (uvicorn and other API dependencies) which are not included in the default cognee installation to keep it lightweight. +The UI requires backend server functionality (uvicorn and other API dependencies) which are not included in the default Cognee installation to keep it lightweight. See the main Installation section above for environment setup.
189-191: Use a fenced code block for the run command and keep the prose tight.Inline triple backticks are harder to read. Prefer a dedicated code block.
-### Running the UI - -Try cognee UI by running ``` cognee-cli -ui ``` command on your terminal. +### Running the UI + +Run: +```bash +cognee-cli -ui +```
189-191: Add expected behavior (URL/host/port) and how to stop.Briefly state what users should see and where to open the UI; note Ctrl+C to stop.
If applicable, append a sentence like: This starts a local server (e.g., http://localhost:XXXX); press Ctrl+C to stop. Please confirm the actual host/port.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
⏰ 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). (6)
- GitHub Check: Basic Tests / Run Unit Tests
- GitHub Check: CLI Tests / CLI Integration Tests
- GitHub Check: CLI Tests / CLI Unit Tests
- GitHub Check: CLI Tests / CLI Functionality Tests
- GitHub Check: End-to-End Tests / Test permissions with different situations in Cognee
- GitHub Check: End-to-End Tests / Deduplication Test
🔇 Additional comments (2)
README.md (2)
181-187: Confirm packaging extra 'api' exists and list the packages it installs (uvicorn, fastapi, fastapi-users, starlette, etc.).
- No extras definition found in pyproject.toml / setup.cfg / setup.py; README currently instructs
pip install 'cognee[api]'(README.md lines 181–187).- Repo clearly uses FastAPI/uvicorn (e.g., cognee/api/client.py imports uvicorn) and deployment/helm/Dockerfile contains a POETRY_EXTRAS arg, but I did not locate an explicit
apiextras list.Action: either add/confirm an
apiextra in the project packaging that enumerates the server deps, or update README to explicitly list the required packages (minimum: uvicorn, fastapi, fastapi-users, starlette).
189-191: Verify the CLI entrypoint and README commandREADME says
cognee-cli -uibut I can't find a packaging entry exposing acognee-cliconsole script; the -ui option is implemented at cognee/cli/_cognee.py (parser.add_argument("-ui", ...)). Add a console_scripts entry (pyproject.toml / setup.cfg / setup.py) forcognee-clior update the README to the actual installed CLI name.
Description
Add more details to README.md on how to install cognee to be able to run
cognee-cli -uiType of Change
Changes Made
Testing
Screenshots/Videos (if applicable)
Pre-submission Checklist
Related Issues
Additional Notes
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.