Skip to main content

fj — one-shot CLI coding agent powered by soothe-nano

Project description

fj

fj is a one-shot coding-agent CLI — everything after the command is the query:

fj who is your name
fj 修改这个文件。
fj explain the auth flow in this repo

It embeds soothe-nano (tools, skills, MCP, subagents, progressive loading) with SQLite persistence and config at ~/.soothe/config/nano.yml.

Package name: fj-ai. Runtime: soothe-nano.

Quick start

1. Install

pip install fj-ai
# or
uv tool install fj-ai

Requires Python 3.11+.

2. Config

Run guided setup for a local OpenAI-compatible server (Ollama, LM Studio, vLLM, ...):

fj setup

fj setup updates only endpoint/key/model basics in ~/.soothe/config/nano.yml and keeps other existing config keys as-is.

You can still copy the bundled example manually:

mkdir -p ~/.soothe/config
cp nano.yml ~/.soothe/config/nano.yml

nano.yml is the minimal local profile; everything else uses soothe-nano defaults.

# start your local server / pull a model, then:
fj who are you
fj list Python files in this directory

Cloud (no config file):

export OPENAI_API_KEY=sk-...
fj summarize README.md

Missing nano.yml falls back to OPENAI_API_KEY or ANTHROPIC_API_KEY.

3. Defaults

Concern Default
Config ~/.soothe/config/nano.yml (SOOTHE_HOME overrides home)
Checkpoints SQLite at ~/.soothe/data/soothe_checkpoints.db
Workspace CWD (SOOTHE_WORKSPACE)
Output Progress on stdout line 1; final answer when done

Usage

fj setup
fj completion zsh|bash
fj [options] [--] <query...>
Flag Meaning
-c PATH / --config Alternate nano.yml
-t ID / --thread Reuse LangGraph thread id
-w DIR / --workspace Workspace root
--no-stream Final-only answer (progress still on TTY)
-v / --verbose Mirror tool/custom events on stderr
-V / --version Version
-- Force remaining argv into the query
# put fj on PATH (pick one)
uv tool install fj-ai
# or: export PATH="/Users/chenxm/Workspace/fj-ai/.venv/bin:$PATH"

# enable Tab completion (zsh)
eval "$(fj completion zsh)"
# persist in ~/.zshrc:
#   eval "$(fj completion zsh)"

Tab completion predicts natural-language intents (not only flags). It uses the router fast model from nano.yml via soothe-nano — it does not start the coding agent. Configure an optional fast role:

router_profiles:
  - name: default
    router:
      default: "local:llama3.2"
      fast: "local:llama3.2:1b"

If fast is omitted, completion falls back to default.

Note: Tab only works when fj is resolvable for the same command you type (on PATH, or as an absolute/venv path). If completion is not installed or fj is missing, Tab falls through silently.## Add skills

Point nano at skill folders (SKILL.md + frontmatter) in nano.yml:

skills:
  - ~/.soothe/skills/my-reviewer
  - ./skills/deploy
~/.soothe/skills/my-reviewer/
  SKILL.md

Powered by

fj is built on soothe-nano — tools, skills, MCP, subagents, and progressive loading, with SQLite persistence.

---
name: my-reviewer
description: Review Python PRs for style and security
---

# Reviewer

When asked to review code, check for ...

Progressive skills are on by default (compact catalog + load on demand). Tune under progressive_skills: in nano.yml.

Add MCP servers

mcp_builtins:
  - playwright

mcp_servers:
  - name: filesystem
    transport: stdio
    command: npx
    args: ["-y", "@modelcontextprotocol/server-filesystem", "/tmp"]
    defer: true
    enabled: true

With defer: true (default), MCP tools activate on demand.

Agent features

fj is a thin CLI over soothe-nano (soothe-deepagents + soothe-sdk).

Layer Behavior
Tools Core tools at startup; deferred via search_tools
Skills Compact listings + search_skills / invoke_skill
MCP Deferred by default; activated on demand

Also included: builtin tool groups, ready subagents (planner, explorer, research, browser), workspace scoping, YAML/env config, SQLite persistence, and middleware (limits, timeouts, retries).

Compared to other agents

For a full TUI coding agent from the same stack, see mirasoth/soothe.

fj / soothe-nano soothe OpenCode Pi-style
Shape Thin one-shot CLI Full TUI + optional daemon Full TUI product (JS/TS) Minimal loops
Agent loop CoreAgent (ReAct) Strange Loop: plan → assess → execute Product agent loop Single / lean loop
Goals One query → answer Goal-oriented; autopilot multi-goal DAG Session / product UX Usually single turn
Autopilot Daemon schedule, dreaming, cron, veritas
Tools / skills / MCP Progressive Same core + TUI / loop durability Product surface Often fixed
Config nano.yml nano.yml + soothe.yml App / project config Code / light config
Best when Scriptable coding in a repo Interactive + 24/7 goal orchestration Daily interactive coding Experiments
  • vs soothe: shared CoreAgent; fj is argv → answer; soothe adds Strange Loop, TUI, and autopilot.
  • vs OpenCode: rich TUI product vs argv → answer (fj) or goal-orchestration stack (soothe).
  • vs Pi-style: lean loops vs progressive loading, workspace security, sqlite threads.

Development

git clone https://github.com/caesar0301/fj-ai.git
cd fj-ai
make sync-dev
make test
make lint

# optional local soothe-nano:
#   uv add --editable ../soothe/packages/soothe-nano
uv run fj who is your name
src/fj_ai/
  cli.py         # argv → query / setup / completion
  config.py      # nano.yml loader
  agent.py       # create_nano_agent + sqlite
  stream.py      # stdout streaming
  completion/    # Tab intent completion (fast model, no agent)
  shell/         # zsh/bash completion scripts
nano.yml
.github/workflows/
  ci.yml
  release.yml
  • CI — format, lint, tests on Python 3.11–3.13; build + twine check
  • Release — GitHub Release / workflow_dispatch → PyPI

License

MIT

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

fj_ai-1.0.3.tar.gz (38.6 kB view details)

Uploaded Source

Built Distribution

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

fj_ai-1.0.3-py3-none-any.whl (38.5 kB view details)

Uploaded Python 3

File details

Details for the file fj_ai-1.0.3.tar.gz.

File metadata

  • Download URL: fj_ai-1.0.3.tar.gz
  • Upload date:
  • Size: 38.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for fj_ai-1.0.3.tar.gz
Algorithm Hash digest
SHA256 041442f538838215e41ca9b6563f4a23deea63bc79c1a44037c05e3b5420436e
MD5 b5a5105ab136452b7ed68493e748652c
BLAKE2b-256 2909f469eb6b03ebc491cb5708003bcff85236e6160963f5bb9eb9ecb9c547df

See more details on using hashes here.

Provenance

The following attestation bundles were made for fj_ai-1.0.3.tar.gz:

Publisher: release.yml on caesar0301/fj-ai

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

File details

Details for the file fj_ai-1.0.3-py3-none-any.whl.

File metadata

  • Download URL: fj_ai-1.0.3-py3-none-any.whl
  • Upload date:
  • Size: 38.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for fj_ai-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 ccdb1371e5e044830916fe95ed017f61f5cbc325d835535e29c13007135c820e
MD5 bb1269b2c089e627a8a37d6bd7c618b1
BLAKE2b-256 3f55443d7cd8a9fa893861b07a1a7bfa0dc32d040090200173ee3b4141971217

See more details on using hashes here.

Provenance

The following attestation bundles were made for fj_ai-1.0.3-py3-none-any.whl:

Publisher: release.yml on caesar0301/fj-ai

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