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.

Metadata

Release files for agent-gateway-cli 26.7.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for agent-gateway-cli 26.7.0
File Size Uploaded Provenance
agent_gateway_cli-26.7.0.tar.gz 15.7 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for agent-gateway-cli 26.7.0
File Interpreter ABI Platform
agent_gateway_cli-26.7.0-py3-none-any.whl Python 3 none any Details

Total release size: 35.1 kB

Release files / agent_gateway_cli-26.7.0.tar.gz

Download URL agent_gateway_cli-26.7.0.tar.gz
Size 15.7 kB
Tags Source
SHA-256 checksum
How to use checksums
1cb5a9f746ca3c67af8e5236d31feffc903127b5f6de80bb621f67f77268a333
BLAKE2b-256 checksum
How to use checksums
d767423bfc5ef99299370141ef44a91da3f624b52f7063edcc815ea7b2ca4e66
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.5

Release files / agent_gateway_cli-26.7.0-py3-none-any.whl

Download URL agent_gateway_cli-26.7.0-py3-none-any.whl
Size 19.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6f42a05dec15558aaa3b6cd8c663c8e8bf9ddb4988545124f5cc12f222fb9643
BLAKE2b-256 checksum
How to use checksums
dcc874223f315212c5f1f09702e23ebbc0f77b75b53ba5e41017684601eaf74b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.5

Security for agent-gateway-cli 26.7.0

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.

Release history Release notifications | RSS feed

This release

26.7.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page