Skip to main content

Stateful, agent-native CLI for the deliberAIde v2 API

Project description

deliberaide-cli

deliberaide-cli is a stateful command-line harness for the DeliberAIde v2 API. It wraps the running FastAPI server over HTTP and WebSockets, keeps a saved profile, and exposes every discovered route through generated command groups.

What it supports

  • One-shot commands for the current HTTP route surface
  • One-shot commands for the current WebSocket route surface
  • Interactive shell mode when you run deliberaide-cli with no subcommand
  • Browser-based CLI sign-in through the DeliberAIde web app
  • Saved base URLs, cookies, and default IDs per profile
  • Machine-readable output with --json
  • Binary downloads with --download

Install

From the repository root:

python -m pip install -e .\agent-harness

If you prefer a project virtual environment, run the same command with that Python executable instead.

Basic usage

deliberaide-cli --help
deliberaide-cli routes list
deliberaide-cli auth login
deliberaide-cli users get-current-user-info
deliberaide-cli context set org_id 11111111-1111-1111-1111-111111111111
deliberaide-cli projects create-project --name "Pilot workspace"

Sign in from the browser

By default, auth login starts a CLI approval session, opens your browser, and waits for approval:

deliberaide-cli --base-url http://127.0.0.1:8000 auth login

If the browser does not open automatically, copy the URL printed in the terminal into any browser on the same machine. After you sign in and approve the request, the CLI saves the returned cookies in your active profile.

You can still fall back to direct credentials when needed:

deliberaide-cli --base-url http://127.0.0.1:8000 auth login --email you@example.com --password secret

JSON request bodies

Use direct field flags for simple object bodies:

deliberaide-cli projects create-project --name "Pilot workspace" --description "CLI-created"

Use raw JSON for richer payloads:

deliberaide-cli projects create-project --body '{"name":"Pilot workspace","target_language":"en"}'

Or load JSON from a file:

deliberaide-cli projects create-project --body-file .\payload.json

Multipart uploads

deliberaide-cli upload upload-audio --file .\meeting.mp3 --discussion-id 22222222-2222-2222-2222-222222222222 --config '{"language":"en"}'
deliberaide-cli upload upload-bulk --files .\a.wav --files .\b.wav --session-id 33333333-3333-3333-3333-333333333333

Binary responses

deliberaide-cli qr get-session-qr-codes-zip --session-id 44444444-4444-4444-4444-444444444444 --download .\session-qr.zip

Profiles and saved defaults

deliberaide-cli profile show
deliberaide-cli profile set-base-url http://127.0.0.1:8000
deliberaide-cli context set discussion_id 55555555-5555-5555-5555-555555555555
deliberaide-cli context show
deliberaide-cli context undo

Interactive shell

Run with no subcommand to enter the shell:

deliberaide-cli

Inside the shell, enter the same commands you would run normally, for example:

routes list
auth login
users get-current-user-info
exit

Tests

python -m pytest .\agent-harness\deliberaide_cli\tests -v

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

deliberaide_cli-0.1.0.tar.gz (87.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

deliberaide_cli-0.1.0-py3-none-any.whl (93.1 kB view details)

Uploaded Python 3

File details

Details for the file deliberaide_cli-0.1.0.tar.gz.

File metadata

  • Download URL: deliberaide_cli-0.1.0.tar.gz
  • Upload date:
  • Size: 87.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for deliberaide_cli-0.1.0.tar.gz
Algorithm Hash digest
SHA256 bf1b6ca9a2d8c9db9ffdafb9569eb13af4a9d3c2c7fbd8da85261c37c205852b
MD5 0383de16c12a5051a79c155091187030
BLAKE2b-256 42a9dd8e108e98d4b0e3c403ae787792ca3417b72e3c6fb438b263245f344ee2

See more details on using hashes here.

File details

Details for the file deliberaide_cli-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for deliberaide_cli-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 29470d4038a0590b1296ba687ae626bd977bbede93a4cc886bfd488c97415a4b
MD5 e3196077cb9cdb2e50ba2a5c6fa2ba09
BLAKE2b-256 44e38d74e0c550aac0d08f25add18e0c3a23cb57a90f9e4e833c8ff53104bbda

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page