backend.ai-cli
Unified command-line interface for Backend.AI
How to adopt in CLI-enabled Backend.AI packages
An example setup.cfg in Backend.AI Manager:
[options.entry_points]
backendai_cli_v10 =
mgr = ai.backend.manager.cli.__main__:main
mgr.start-server = ai.backend.gateway.server:main
Define your package entry points that returns a Click command group using a
prefix, and add additional entry points that returns a Click command using a
prefix followed by a dot and sub-command name for shortcut access, under the
backendai_cli_v10 entry point group.
Then add backend.ai-cli to the install_requires list.
You can do the same in setup.py as well.
Shell Tab Completion
The CLI provides built-in shell tab completion support for bash, zsh, and fish shells.
Quick Setup
# Show completion setup instructions
backend.ai completion --show
# Install completion automatically
backend.ai completion --shell bash # Install to ~/.bashrc
backend.ai completion --shell zsh # Install to ~/.zshrc
backend.ai completion --shell fish # Install to fish completions
Manual Setup
If you prefer manual setup, you can add completion to your shell configuration:
Bash (~/.bashrc):
eval "$(_BACKEND_AI_COMPLETE=bash_source backend.ai)"
Zsh (~/.zshrc):
eval "$(_BACKEND_AI_COMPLETE=zsh_source backend.ai)"
Fish (~/.config/fish/config.fish):
backend.ai completion --shell fish | source
Features
Tab completion supports:
- Commands: All available commands and subcommands
- Options: Short and long flags with descriptions
- Arguments: Context-aware argument completion where applicable
- Help: Descriptions for commands and options
Examples
backend.ai <TAB> # Show all available commands
backend.ai session <TAB> # Show session subcommands
backend.ai session create <TAB> # Show creation options
backend.ai --<TAB> # Show global options
1 maintainer
Metadata
1 maintainer
Release files for backend.ai-cli 26.4.18
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| backend_ai_cli-26.4.18.tar.gz | 12.9 kB | Without provenance | Details for backend_ai_cli-26.4.18.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| backend_ai_cli-26.4.18-py3-none-any.whl | Python 3 | none | any | Details for backend_ai_cli-26.4.18-py3-none-any.whl |
Total release size: 27.1 kB
Release files / backend_ai_cli-26.4.18.tar.gz
| Download URL | backend_ai_cli-26.4.18.tar.gz |
|---|---|
| Size | 12.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7ec85bcbee2ba25b93a1c2040e402e48aa29d41317e58de2d392972496d8adde
|
|
BLAKE2b-256 checksum How to use checksums |
ccbd3899bd2e94dc0f27b224ffc18d83b89c5095097f1a4d5c93758dc6ec8bd6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.2.0 CPython/3.13.18
|
Release files / backend_ai_cli-26.4.18-py3-none-any.whl
| Download URL | backend_ai_cli-26.4.18-py3-none-any.whl |
|---|---|
| Size | 14.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
4e4e19bdb1004ca5e0dc5ca3a875dc87231b91fd1ff74745dc8eb882eb8cded2
|
|
BLAKE2b-256 checksum How to use checksums |
8387a09ecb5ed7739f0022d57f77832c9800283249ff89ba131f256d1fb38221
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.2.0 CPython/3.13.18
|
Security for backend.ai-cli 26.4.18
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
