Skip to main content

An open-source offensive-security AI agent that lives in your terminal.

Project description

riftor

An open-source offensive-security AI agent that lives in your terminal. Find the rift. Open it. Cross through.

PyPI CI License: GPL-3.0

riftor demo

riftor is a Python TUI pentest assistant: a full-screen Textual interface backed by litellm, organised around the RIFT methodology — Recon → Intrusion → Foothold → Takeover.

It's cloud-first (Anthropic, OpenAI, OpenRouter, …) for the strongest agent behaviour, with local Ollama supported as an option.

Status: fully featured (Phase 4–6). Streaming agent with retry/backoff + token/cost metering, persistent granular permissions (allow/deny rules, diff preview before write/edit), scope guardrail (enforce / dry-run / import-export), RIFT stage tracking, per-engagement findings store (edit/tag/ dedup), CVSS reports in md/html/json/sarif, crash-safe sessions, input history + command palette, headless one-shot mode, Docker, pytest + types in CI. See todo.md for the roadmap and docs/ for configuration.

Install

pip install riftor          # or: uv tool install riftor / pipx install riftor

Requires Python 3.11+ and a model — set one of ANTHROPIC_API_KEY, OPENAI_API_KEY, OPENROUTER_API_KEY (or run a local Ollama server).

export ANTHROPIC_API_KEY=sk-ant-...   # or OPENAI_API_KEY, etc.
riftor                                 # launch the TUI
riftor --config                        # show the config file path
riftor --version
riftor --model openai/gpt-4o           # override the model for this run
riftor --workdir ./engagement          # set the engagement directory
riftor --scope-file scope.txt          # preload scope targets
riftor -p "enumerate 10.0.0.5"         # headless one-shot (also reads stdin)
riftor --doctor                        # check which recon tools are installed

On first launch riftor writes a config file and picks a default model from your environment keys (cloud-first); if no key is set but an Ollama server is running, it falls back to that.

From source

git clone https://github.com/Estudely/riftor && cd riftor
uv sync && uv run riftor

Docker

docker build -t riftor .
docker run -it --rm -e ANTHROPIC_API_KEY -v "$PWD:/work" riftor

The image is minimal (no nmap/httpx/etc.). For full recon tooling, build the bundled variant (docker build --build-arg INSTALL_TOOLS=1 -t riftor:full .), run riftor on a host that has the tools, or extend the image. Missing tools aren't fatal — the agent sees the failed command and adapts; run /doctor (or riftor --doctor) to see which tools are on PATH up front.

Configure

~/.config/riftor/config.toml:

[riftor]
model = "anthropic/claude-sonnet-4-6"  # any litellm model id
# api_key = "sk-..."                   # prefer the provider's env var
temperature = 0.3
max_tokens = 2048
theme = "rift"
lore = true

# Local option (Ollama):
# model = "ollama_chat/llama3.1"
# api_base = "http://localhost:11434"

Workflow

1. Set scope        /scope add 10.0.0.0/24 example.com
2. Task the agent   "enumerate the web host and look for low-hanging fruit"
                    → it runs recon tools via bash (you approve), records
                      services/findings, and advances the R·I·F·T stage
3. Review           /findings
4. Report           /report            → .riftor/reports/report-*.md and .html

Out-of-scope targets are blocked (with an explicit per-call override). State lives in .riftor/ per working directory; sessions auto-save and resume.

Commands

Command Action
/help show commands
/clear clear the conversation (Ctrl+L)
/retry · /continue [N] · /compact re-run last turn · extend steps · free context
/copy · /show <id> · /cost copy last output · expand a result · token/cost total
/model [name] · /theme [name] switch model / theme
/stage [R|I|F|T] show or set the RIFT stage
/scope [add|out|rm <t>|clear|on|off|dry|import <f>|export [f]] manage scope
/findings · /finding <id> list (severity-sorted) / show one
/edit-finding <id> sev=high tags=… · /delete-finding <id> triage findings
/hosts · /services discovered infrastructure
/report [md|html|json|sarif|both|all] write a report to .riftor/reports/
/timeline · /export engagement activity log · archive the engagement
/permissions · /audit review allow/deny rules · recent tool-call log
/doctor check which external recon tools (nmap/httpx/…) are installed
/sessions · /resume <id> · /new manage saved sessions
/config · /tools · /lore · /exit settings · tools · persona · quit

↑/↓ recall previous prompts · PgUp/PgDn scroll · Ctrl+P command palette · Esc cancels a running response. Dangerous tools (bash/write/edit) prompt for approval (with a diff preview); rm -rf/dd and friends are denied by default; every tool call is written to an audit log. See docs/configuration.md for all settings.

Use responsibly

riftor is for authorized security testing only. You are responsible for having explicit, written permission for any system you assess.

License

GPL-3.0.

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

riftor-0.1.0.tar.gz (1.6 MB view details)

Uploaded Source

Built Distribution

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

riftor-0.1.0-py3-none-any.whl (85.7 kB view details)

Uploaded Python 3

File details

Details for the file riftor-0.1.0.tar.gz.

File metadata

  • Download URL: riftor-0.1.0.tar.gz
  • Upload date:
  • Size: 1.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for riftor-0.1.0.tar.gz
Algorithm Hash digest
SHA256 6987121aeb315c57fb10def42ad5f107d151ccfe86c73ef1aa1eb6abe46bab2d
MD5 7c94b6a85b4d5414a90706269c66298e
BLAKE2b-256 2e9cdf70a138adfa6ed9d8d61aa8dcbd605e66e4db0839d0da5a3bdc34cae487

See more details on using hashes here.

Provenance

The following attestation bundles were made for riftor-0.1.0.tar.gz:

Publisher: release.yml on Estudely/riftor

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file riftor-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: riftor-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 85.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for riftor-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ee89ad30dbf20d295161f46b7e907c0f2f470183da9d76e0d1b1e1177c68b5a0
MD5 b4fee1147821039f683101dc4bcb1540
BLAKE2b-256 082939d0597054586500cd7e8869612a9527be8dd0bdebdfc31fef53c54174c3

See more details on using hashes here.

Provenance

The following attestation bundles were made for riftor-0.1.0-py3-none-any.whl:

Publisher: release.yml on Estudely/riftor

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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