Skip to content

Docs: the CLI-like API page shows a working, CI-run example (#98) - #127

Merged
DraTeots merged 1 commit into
v2-mainfrom
fix-98-cli-like-api
Nov 3, 2026
Merged

DraTeots merged 1 commit into
v2-mainfrom
fix-98-cli-like-api

Conversation

@DraTeots

@DraTeots DraTeots commented Nov 3, 2026

Copy link
Copy Markdown
Contributor

The wiki page #98 names still shows ConsoleContext; the docs page that replaced it (docs/apis/python-cli-like.md) had a wrong command (mkdir /test/testable2 x y z) and no way to read output.

  • New python/examples/example_cli_like_api.py: CliManager set up, mkdir, mktbl, add, vers and dump with output captured as a string, an error caught as an exception, cleanup so it runs again. Run twice on one database here.
  • The docs page shows the file verbatim; scripts/docs/test_cli_like_docs.py fails if they drift.
  • python-examples.yml runs the example on Python 3.9.

The wiki page itself gets a short pointer to the docs page (pushed to the wiki repository separately; wikis have no PRs).

Closes #98

🤖 Generated with Claude Code

The page showed `mkdir /test/testable2 x y z` (mktbl's syntax) and no way to read a command's output. It now
shows python/examples/example_cli_like_api.py verbatim: CliManager set up, mkdir, mktbl, add, vers and dump with
the output captured as a string, an error caught as an exception, and a cleanup so it runs again. The Python
examples workflow runs the example on Python 3.9; scripts/docs/test_cli_like_docs.py fails when the page's block
and the file differ.

Closes #98

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@DraTeots
DraTeots merged commit 693f1a1 into v2-main Nov 3, 2026
50 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

"Python CLI like API" wiki page is wrong

1 participant