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
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file backend_ai_cli-26.8.3.tar.gz.
File metadata
- Download URL: backend_ai_cli-26.8.3.tar.gz
- Upload date:
- Size: 12.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.2.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d71fe7159cdd64b740adf702f5fe027d42426c0c28e751a4d1dc5ff172a6008c
|
|
| MD5 |
1db87e8decb9533f937a65bb24f3eea2
|
|
| BLAKE2b-256 |
b2dc71839cedcbc432c32b3741100a719bc2dbc50826205f35cf7aed55c3aa82
|
File details
Details for the file backend_ai_cli-26.8.3-py3-none-any.whl.
File metadata
- Download URL: backend_ai_cli-26.8.3-py3-none-any.whl
- Upload date:
- Size: 14.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.2.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
887365fd0d4a1c0b0e084568b1681dd592fee4daa8408b044cfac9d97bf915fc
|
|
| MD5 |
58c3ad715779a79f67c95e75124a9387
|
|
| BLAKE2b-256 |
77391aa59d2ba36d38bf3a1467251df3c67aac9f61feffa2ce776f524b6995e3
|
