Skip to main content

TopicFlow remote CLI.

Project description

TopicFlow CLI

topicflow-cli is the standalone remote CLI for TopicFlow.

It talks to a deployed TopicFlow API over HTTP:

topicflow -> HTTP API -> TopicFlow services

Install

Recommended:

pipx install topicflow-cli

Upgrade:

pipx upgrade topicflow-cli

Run without adding it to PATH:

pipx run topicflow-cli --help

Configuration

Default API base URL:

http://127.0.0.1:8000

Environment variables:

TOPICFLOW_CLI_API_BASE_URL=http://topicflow.example.com
TOPICFLOW_CLI_TIMEOUT_SECONDS=600

Or override per command:

topicflow --base-url http://topicflow.example.com system doctor

Quick Start

topicflow --help
topicflow system doctor
topicflow product list

Publish

Build the standalone package from the repo root:

python -m pip install build twine
python -m build apps/cli
python -m twine check apps/cli/dist/*

Upload to TestPyPI:

python -m twine upload --repository testpypi apps/cli/dist/*

Upload to PyPI:

python -m twine upload apps/cli/dist/*

After publishing, end users can install with:

pipx install topicflow-cli

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

topicflow_cli-0.1.0.tar.gz (7.1 kB view details)

Uploaded Source

Built Distribution

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

topicflow_cli-0.1.0-py3-none-any.whl (7.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for topicflow_cli-0.1.0.tar.gz
Algorithm Hash digest
SHA256 e6f832301e16602943d7b51f1fd4e4ea19db40387e884aabb61dd5d7ff1c835b
MD5 e05323f4621080b9784848c60bff104c
BLAKE2b-256 511f2f15c1181c0e790cf04dc70621d475450031e82a9bcaec64dbfe1331ae17

See more details on using hashes here.

File details

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

File metadata

  • Download URL: topicflow_cli-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 7.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.13

File hashes

Hashes for topicflow_cli-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 afdce35436ba3fdc77d0408ebbf07e38bf1aa982f7743502a0196e4a1f0556eb
MD5 2cd587c0eb10f45fd65745c7a845f72b
BLAKE2b-256 de9d8f9eb7d307de639c452b9cf0f742ccda309dd00116595d82a9d7b3e43bbd

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