Skip to main content

agent-gateway-cli

agent-gateway-cli is a terminal client for interacting with an online agent gateway. It provides an interactive shell for authentication, sessions, settings, and agent conversations.

The installed command is:

agw

Requirements

  • Python 3.13 or newer
  • Access to an agent gateway

Install

Install the latest release from PyPI:

python -m pip install agent-gateway-cli

The package can also be installed from a local checkout:

python -m pip install .

Initialize

Create the default configuration with the gateway URL:

agw --init https://gateway.example.com

This creates the configuration file only if it does not already exist. The default location is:

  • Unix-like systems: ~/.agent_gateway_cli.yaml
  • Windows: %USERPROFILE%\.agent_gateway_cli.yaml

If the file already exists, initialization fails without changing it.

To initialize a different file:

agw --config /path/to/cli.yaml --init https://gateway.example.com

On Windows PowerShell:

agw --config C:\path\to\cli.yaml --init https://gateway.example.com

Run

Start the interactive client:

agw

The client displays its version, then prompts for gateway credentials. Type help in the shell to see available commands. Common commands include:

auth login
auth logout
motd
session list
session show
session switch <session-id>
set
set streaming_enabled true
quit

Use --config to select a non-default configuration file:

agw --config /path/to/cli.yaml

The same path can be supplied through AGF_CLI_CONFIG_PATH.

Configuration

The example configuration is available at config/cli.yaml.example:

base_url: https://gateway.example.com
settings_path: ~/.agent_gateway_cli.yaml
history_path: ~/.agent_gateway_cli_history
history_entries: 50
request_timeout: 120

Local settings are stored in settings_path. Command history is stored separately in history_path and is limited to history_entries lines per user. The default history limit is 50.

To disable the shell's friendly error recovery and allow interrupts and exceptions to propagate:

agw --no-error-handling

Package names

  • PyPI distribution: agent-gateway-cli
  • Python package: agent_gateway_cli
  • Console command: agw

License

This project is licensed under the MIT License.

Download files

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

Source Distribution

agent_gateway_cli-26.7.0.tar.gz (15.7 kB view details)

Uploaded Source

Built Distribution

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

agent_gateway_cli-26.7.0-py3-none-any.whl (19.4 kB view details)

Uploaded Python 3

File details

Details for the file agent_gateway_cli-26.7.0.tar.gz.

File metadata

  • Download URL: agent_gateway_cli-26.7.0.tar.gz
  • Upload date:
  • Size: 15.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for agent_gateway_cli-26.7.0.tar.gz
Algorithm Hash digest
SHA256 1cb5a9f746ca3c67af8e5236d31feffc903127b5f6de80bb621f67f77268a333
MD5 eb3fe4a6d783477a76c063ede7ebef0a
BLAKE2b-256 d767423bfc5ef99299370141ef44a91da3f624b52f7063edcc815ea7b2ca4e66

See more details on using hashes here.

File details

Details for the file agent_gateway_cli-26.7.0-py3-none-any.whl.

File metadata

File hashes

Hashes for agent_gateway_cli-26.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6f42a05dec15558aaa3b6cd8c663c8e8bf9ddb4988545124f5cc12f222fb9643
MD5 9de9ebc27f1129a34660162fd90619b4
BLAKE2b-256 dcc874223f315212c5f1f09702e23ebbc0f77b75b53ba5e41017684601eaf74b

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 Sentry Error logging StatusPage Status page