Skip to main content

CLI for the OneFirewall AI Gateway — chat, stream, and build agents from your terminal

Project description

onefirewall-ai

CLI for the OneFirewall AI Gateway — chat, stream, and build agents from your terminal.

PyPI Python License: MIT


Installation

pip install onefirewall-ai

Quick Start

1. Login

onefirewall-ai login

You'll be prompted for:

  • Endpoint — your OneFirewall AI Gateway URL (e.g. https://onefirewall.ai)
  • API Key — generate one from the Profile page in the dashboard

Credentials are saved to ~/.onefirewall-ai/access.json.

2. Chat

onefirewall-ai What is the capital of France?
onefirewall-ai "Explain Kubernetes in simple terms"
onefirewall-ai Write a Python function to reverse a string

The response streams directly to your terminal in real time.


Commands

Command Description
onefirewall-ai Show help
onefirewall-ai help Show help
onefirewall-ai login Configure endpoint & API key
onefirewall-ai <message> Send a message and stream the AI response
onefirewall-ai version Show version

Home Directory

All data is stored in ~/.onefirewall-ai/:

~/.onefirewall-ai/
├── access.json          # Endpoint + API key (private)
├── MEMORY.md            # Persistent facts the agent remembers
├── SOUL.md              # System prompt / agent persona
└── sessions/
    └── session1.md      # Full conversation history

Customise your agent

Edit ~/.onefirewall-ai/SOUL.md to change the AI's persona:

# Soul
You are a concise senior DevOps engineer. Always prefer CLI examples.

Edit ~/.onefirewall-ai/MEMORY.md to give the AI persistent context:

# Memory
- My project uses Python 3.12 and FastAPI.
- Always prefer async/await patterns.

API Reference

The CLI uses the OpenAI-compatible endpoint:

POST {endpoint}/api/v1/chat/completions

With stream: true and SSE parsing for real-time output.


License

MIT © OneFirewall

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

onefirewall_ai-0.1.1.tar.gz (10.7 kB view details)

Uploaded Source

Built Distribution

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

onefirewall_ai-0.1.1-py3-none-any.whl (12.0 kB view details)

Uploaded Python 3

File details

Details for the file onefirewall_ai-0.1.1.tar.gz.

File metadata

  • Download URL: onefirewall_ai-0.1.1.tar.gz
  • Upload date:
  • Size: 10.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.7

File hashes

Hashes for onefirewall_ai-0.1.1.tar.gz
Algorithm Hash digest
SHA256 29ca8004cd7d381745965cf1342baf8253bd3c0bd13150fbe3c3cfbfa445ecf0
MD5 d812405ac7b7f26760098f60b701569d
BLAKE2b-256 bff66bb1f04af5c51c7972da84ef0a4925fa37cc8c6fe5b3b04733aa92d20181

See more details on using hashes here.

File details

Details for the file onefirewall_ai-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: onefirewall_ai-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 12.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.7

File hashes

Hashes for onefirewall_ai-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 efac53f811fc38caeb7514d319b53fc8f8d392756dd8bee2c8fd2adbad64258b
MD5 0674a280ce8fb72f972436aff95816a5
BLAKE2b-256 96de1c7ad44b70915a8ad5f696bcf455c78f97cf148b29244c6f944b11ce4e97

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