Skip to content

docs: add project to CLI examples#947

Open
blankanswer wants to merge 1 commit into
DeusData:mainfrom
blankanswer:agent/docs-readme-project-examples
Open

docs: add project to CLI examples#947
blankanswer wants to merge 1 commit into
DeusData:mainfrom
blankanswer:agent/docs-readme-project-examples

Conversation

@blankanswer

Copy link
Copy Markdown

What does this PR do?

Updates the README CLI examples to include the required project field for project-scoped tool calls.

The previous examples showed commands such as search_graph, trace_path, query_graph, and --raw search_graph without a project value, which can lead to project not found or not indexed errors when users copy the examples directly.

This PR also adds a short note telling users to run list_projects first and use the returned project name as the project value.

Closes #945.

Checklist

  • Every commit is signed off (git commit -s) — required, CI rejects unsigned commits (DCO, see CONTRIBUTING.md)
  • Tests pass locally (make -f Makefile.cbm test) — not run; docs-only change
  • Lint passes locally (make -f Makefile.cbm lint-ci) — not run; docs-only change
  • New behavior is covered by a test — not applicable; README-only documentation fix

Signed-off-by: Blank_Answer <97771966+blankanswer@users.noreply.github.com>
@blankanswer blankanswer requested a review from DeusData as a code owner July 8, 2026 02:59
@blankanswer

Copy link
Copy Markdown
Author

Looks like ci-ok failed only because test / test-windows (windows-latest, CLANG64, x86_64) was cancelled. This PR only changes docs/Markdown, and the product-change detector reports product=false.

Could maintainers rerun the cancelled Windows job or rerun failed jobs?

@DeusData DeusData added documentation Improvements or additions to documentation ux/behavior Display bugs, docs, adoption UX priority/normal Standard review queue; useful PR with ordinary maintainer urgency. labels Jul 8, 2026
@DeusData

DeusData commented Jul 8, 2026

Copy link
Copy Markdown
Owner

Thanks for tightening the CLI docs. Triage: docs-only PR for #945, normal priority. Review focus is simply that every example now names the project where the command requires it and matches v0.9.0 behavior.

@DeusData DeusData added this to the 0.9.1-rc milestone Jul 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation priority/normal Standard review queue; useful PR with ordinary maintainer urgency. ux/behavior Display bugs, docs, adoption UX

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Please update readme.md:The sample code lacks necessary parameters.

2 participants