An open-sourced, terminal-based AI coding agent.
Project description
Postal
Postal, an open-source AI coding agent that runs in your terminal. It connects to LLMs through OpenRouter, reads and edits your code with a built-in tool set, runs shell commands, and streams everything through a full-screen TUI.
[!WARNING] Work in progress. The agent loop, tool calling, terminal UI, and approval flow work end to end. The approval policy is set in config (
approval = "on_request"by default), there is no way to switch it mid-session yet. Sub-agents still auto-approve their own tool calls, so use Postal in a directory you don't mind it touching
Functionality
Interface
| Interactive TUI | Full-screen terminal interface built on Rich, with streaming responses, live tool call output, and token usage tracking. |
| Single-shot mode | Pass a prompt as an argument for non-interactive runs, suitable for scripting. |
Tools
| Files | read, write, edit, grep, glob, and list_directories for working with a codebase. |
| Shell | The shell tool executes commands in the working directory. |
| Planning | A plan tool tracks steps (a todo list) across the agent loop. |
| Network | Web search via DuckDuckGo and URL fetching. |
| Memory | Key-value storage that survives across sessions. |
| MCP | Connects to external MCP servers for additional tools and data sources. |
Agent
| Approvals | Mutating tool calls are gated by an approval policy, from confirming every write to running unattended. See Approvals. |
| Sub-agents | Specialized agents the main agent can delegate to: codebase_investigator, code_reviewer, software_architect, test_writer, debugger. |
AGENTS.md |
Project instructions are picked up automatically and followed while working. |
| Context pruning | Old tool outputs are cleared once they pile up past the recent working set, reclaiming tokens without touching the conversation itself. |
| Compaction | When the context window fills up, history is summarized into a continuation brief and the session resumes from it instead of erroring out. |
| OpenRouter backend | Authenticate once with postal login (browser OAuth) or paste an API key. Model, temperature, and context window are configurable in ~/.config/postal/config.toml, with per-project overrides in .postal/config.toml. |
Getting started
# 1. Install Postal
pip install postalcli
# 2. Log in (opens your browser to authorize with OpenRouter)
postal login
postal login --paste # or paste an API key directly
# 3. Run it
postal # interactive mode
postal "your prompt" # single-shot mode
postal --cwd /path # run against a different working directory
# Remove the saved API key
postal logout
Approvals
Before Postal runs anything that changes state, the approval policy decides whether it goes ahead, asks you, or is refused outright. Read-only tools (read, grep, glob, list_directories, plan) never prompt, so a policy only affects writes, shell commands, network calls, memory writes, MCP tools, and sub-agent runs.
Set it with the approval key in your config file:
# ~/.config/postal/config.toml (user-wide), or .postal/config.toml (per project)
approval = "on_request"
| Value | Badge | Behaviour |
|---|---|---|
on_request (default) |
ask |
Confirm every mutating tool call. Commands matched as known-safe (ls, git status, grep, …) run without asking. |
auto_edit |
auto-edit |
File edits and writes inside the working directory go through unprompted; shell commands still need confirmation unless known-safe. |
auto |
auto |
Everything runs except dangerous commands, which are rejected. |
on_fail |
on fail |
Currently identical to auto. Reserved for prompting after a failed tool call, which is not implemented yet. |
never |
read-only |
Rejects anything that isn't a known-safe command. Nothing gets written, and you are never prompted. |
yolo |
yolo |
Approves everything, including commands matched as dangerous. Only use this in a sandbox or container. |
Two rules apply on top of the policy, and no policy except yolo overrides them:
- Dangerous commands are rejected.
rm -rf /,dd if=,mkfs,shutdown,curl … | bash, fork bombs, and similar patterns are refused before the shell ever sees them (the full list isDANGEROUS_PATTERNSinsafety/approval.py). - Anything touching a path outside the working directory is confirmed, however permissive the policy is (
neverrejects it instead).
The active policy is printed at startup and shown in the prompt badge, colour-coded by risk: normal for ask, auto-edit and read-only, amber for auto and on fail, red for yolo.
Answering a prompt
When confirmation is needed, Postal pauses the stream and shows the tool, its arguments, the command it wants to run, and a diff for file edits:
⏵ edit needs your approval
Edit postal/config/config.py
╭─────────────────────────────────────────╮
│ - approval: ApprovalPolicy = ON_REQUEST │
│ + approval: ApprovalPolicy = AUTO_EDIT │
╰─────────────────────────────────────────╯
y accept · n reject · esc reject approval: ask - confirm every mutating tool
y, a or enter approves; n, d, q, esc or ctrl+c rejects. A rejection is fed back to the agent as a failed tool call, so it can pick a different approach rather than stopping.
[!NOTE] Two gaps to be aware of: the policy is fixed for the session (a
/approvalcommand is on the roadmap), and sub-agents run with their own auto-approving manager, so tool calls they make are not routed to you.
Project instructions (AGENTS.md)
Drop an AGENTS.md at the root of your repo and Postal loads it as developer instructions at startup, use it for build and test commands, code style, or anything else the agent should know before touching your code
Postal walks up from the working directory to the repository root, so running postal inside a subdirectory still picks up the root file. Every AGENTS.md found along the way is included, ordered outermost first.
# AGENTS.md
## Commands
- Test: `pytest`
- Lint: `ruff check .`
## Style
- Type hints on all public functions.
The scope of an AGENTS.md file is the directory tree it sits in, and the more deeply nested file wins on conflicts. Files below the working directory are read on demand as the agent works in those subdirectories. Instructions you give directly in a prompt always take precedence over AGENTS.md.
Roadmap
Currently being worked on:
- Session management: saving, resuming, and switching between sessions.
- Slash commands: in-session commands (e.g.
/approvalto switch approval mode) instead of only config-file settings. - Approval flow: prompting before file edits and shell commands is in place; still to come is switching the mode mid-session and extending confirmations to sub-agents.
License
Project details
Release history Release notifications | RSS feed
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 postalcli-0.0.22.tar.gz.
File metadata
- Download URL: postalcli-0.0.22.tar.gz
- Upload date:
- Size: 81.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8be960328c018fcb482c43cee01a03be48c759bcc25f6721806a91a113a5b701
|
|
| MD5 |
82c796c1176905ff839622057e693ea0
|
|
| BLAKE2b-256 |
059e6ac9fc71382a0a9f8aa7255988e1362127c64426886a948601631d0646a2
|
Provenance
The following attestation bundles were made for postalcli-0.0.22.tar.gz:
Publisher:
python-publish.yml on andrefetch/postal
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
postalcli-0.0.22.tar.gz -
Subject digest:
8be960328c018fcb482c43cee01a03be48c759bcc25f6721806a91a113a5b701 - Sigstore transparency entry: 2277953778
- Sigstore integration time:
-
Permalink:
andrefetch/postal@301cdd9b2e4ca17a2728eae398e0b40bf7103e9b -
Branch / Tag:
refs/tags/v0.0.23 - Owner: https://github.com/andrefetch
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
python-publish.yml@301cdd9b2e4ca17a2728eae398e0b40bf7103e9b -
Trigger Event:
release
-
Statement type:
File details
Details for the file postalcli-0.0.22-py3-none-any.whl.
File metadata
- Download URL: postalcli-0.0.22-py3-none-any.whl
- Upload date:
- Size: 96.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
dee7daeba5000b05180be904a0d4531f033f67da83aa4bb2da25e94f082bfa1c
|
|
| MD5 |
fd48637e1970456658891df6060be2da
|
|
| BLAKE2b-256 |
7e1f7a83a06c0757682d9bcb0b99c5c0a70c3b4b228946ce365021b7b3988e39
|
Provenance
The following attestation bundles were made for postalcli-0.0.22-py3-none-any.whl:
Publisher:
python-publish.yml on andrefetch/postal
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
postalcli-0.0.22-py3-none-any.whl -
Subject digest:
dee7daeba5000b05180be904a0d4531f033f67da83aa4bb2da25e94f082bfa1c - Sigstore transparency entry: 2277953842
- Sigstore integration time:
-
Permalink:
andrefetch/postal@301cdd9b2e4ca17a2728eae398e0b40bf7103e9b -
Branch / Tag:
refs/tags/v0.0.23 - Owner: https://github.com/andrefetch
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
python-publish.yml@301cdd9b2e4ca17a2728eae398e0b40bf7103e9b -
Trigger Event:
release
-
Statement type: