Skip to main content

AI-powered CLI assistant for coding, pentesting, and SOC work

Project description

franki

AI-powered terminal assistant for developers and security professionals.

franki is an open source CLI that brings AI assistance directly to your terminal — for coding, CEH/pentesting, SOC analysis, and exam prep. It supports multiple free AI providers with automatic fallback when one hits a rate limit.

Install

pip install franki

After installing, run:

franki init

Quick start

franki                                          # launch interactive REPL
franki "explain this nmap output"
franki @myfile.py "refactor this function"
franki "!nmap -sV 192.168.8.1" "what does this mean"

Skills

Switch skills with /skill inside the REPL:

Skill Purpose
coding Code generation, review, debugging
pentest CEH-aligned recon, exploitation help
soc Log analysis, alert triage, MITRE
ceh CEH v13 exam prep and quizzes

Providers

franki works with multiple free AI APIs and automatically falls back when one hits a rate limit:

  • Groq (free — groq.com)
  • Google Gemini (free — aistudio.google.com)
  • OpenRouter (free tier — openrouter.ai)
  • DelkaAI (coming soon)

Configure keys with:

franki config

Slash commands

/skill <name>    switch skill (coding/pentest/soc/ceh)
/model <name>    switch AI model
/clear           clear conversation
/history         show current session
/help            show all commands
/exit            quit

Coming in Phase 2+:

/export          save session to markdown
/note <text>     save a finding note
/scope <ip>      set pentest target scope
/quiz            CEH flashcard quiz
/report          generate pentest report from session
/mitre <text>    map behaviour to MITRE ATT&CK

Configuration

franki stores config at ~/.config/franki/config.json.

franki config list                   # show all config (keys masked)
franki config set groq.api_key sk-…  # set a value
franki config get active_model       # read a value
franki config reset                  # reset to defaults
franki init                          # re-run setup wizard

License

MIT — built by Frank Dela Nutsukpuie

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

franki_cli-0.1.0.tar.gz (36.7 kB view details)

Uploaded Source

Built Distribution

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

franki_cli-0.1.0-py3-none-any.whl (46.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: franki_cli-0.1.0.tar.gz
  • Upload date:
  • Size: 36.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for franki_cli-0.1.0.tar.gz
Algorithm Hash digest
SHA256 0f8d2d64ffa8a75922fb1a0d9291a3bfbc1ddc7a968bda113587483062645495
MD5 52d7e27444ef6bbee7793d838fcc74b7
BLAKE2b-256 ba87a520650dfffd5de47e936a5e72662c5158eb24a4600a4641cf3ba60278fe

See more details on using hashes here.

File details

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

File metadata

  • Download URL: franki_cli-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 46.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for franki_cli-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0bc90b3d272a372b79837889b36a78f4989a5757042039bd472a57a8c384a8b0
MD5 0344f257e715f5b2e1feee9338e963fe
BLAKE2b-256 7a34757f9232fa0956cf316068930f1e79a591e544e10cecfb329669491105d6

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