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.

3. Session Management

By default, every new command creates a unique session so conversation history is maintained separately. You can view past sessions or resume a previous session:

# List all recent chat sessions
onefirewall-ai sessions

# Continue an existing session by ID
onefirewall-ai --session <session-id> "What did we just talk about?"

# Create a custom named session
onefirewall-ai --session my-coding-task "Help me write a Python script"

4. Piped Input (stdin)

You can also pipe content directly into the CLI. This is perfect for logs, command outputs, or quick text.

# Pipe a file's content
cat data.txt | onefirewall-ai "Summarize this"

# Pipe the output of another command
ls -l | onefirewall-ai "What are these files?"

# Combine piping and text prompt
echo "Hello AI" | onefirewall-ai "Repeat this back"

# Listing files and asking for an explanation
ls -l | onefirewall-ai "Which of these files were modified today?"

# Checking active processes
ps | onefirewall-ai "Are there any high memory processes running?"

Commands

Command Description
onefirewall-ai Show help
onefirewall-ai help Show help
onefirewall-ai login Configure endpoint & API key
onefirewall-ai sessions List all recent chat sessions
onefirewall-ai [--session ID] <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/
    └── <session_id>.md  # Full conversation history for each session

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.3.tar.gz (12.5 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.3-py3-none-any.whl (13.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: onefirewall_ai-0.1.3.tar.gz
  • Upload date:
  • Size: 12.5 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.3.tar.gz
Algorithm Hash digest
SHA256 69464ad9a0adee46d1d1f1c4c3dd526ec85a52cc718b889e6c40ec95d746887a
MD5 94f4b605d9819ab1eed72e9ffece0333
BLAKE2b-256 ae4ee069c9f0e2174d3439b36cd8b0c4ce57962567cf513e51686c416dcf8dd0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: onefirewall_ai-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 13.8 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 dc1a611eccf29fc691552c160243a90d30cf846e5efa48050de85bf0aea70ddc
MD5 2406bdf26f493c696b610c4cc54120ed
BLAKE2b-256 088bed29221ab02427f301928eae3d8dbb3d3830aea3503fb01779e188164459

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