Session-rooted CLI for evidence retrieval, durable investigation state, and linked peer workflows
Project description
Gotta
gotta is a session-rooted CLI for evidence retrieval, durable investigation
state, and linked peer workflows.
The public surface stays small:
gotta <plugin> ...
gotta ... is the canonical operator path. It binds or discovers the right
session for the current context, hydrates the runtime environment, and dispatches
the requested plugin with that session active. You do not need to cd into the
session root first.
Why It Is Shaped This Way
gotta is deliberately native-first:
- prefer provider-native retrieval and mutation surfaces over ad hoc shell workarounds
- keep durable truth in session state, not in terminal scrollback
- make every material read reopenable through native locators
The normal investigation loop expands and compresses repeatedly:
- retrieve one or two strong anchors through provider-native search or read
- expand outward into adjacent evidence
- compress that evidence web through
session manifest,timeline,graph,leads, andanalyze - record friction and broken affordances in
oops - refine the next retrieval wave from durable state instead of memory
OOPS.md is not incidental note-taking. state/oops.jsonl is the canonical
friction log, projected into OOPS.md, and is meant to capture operator-visible
seams: misleading contracts, broken continuations, coverage gaps, and workflow
friction worth fixing.
Installation
If you do not already have uv, install it first from Astral's official
installation guide.
Install with uv:
uv tool install gotta
That installs the gotta entrypoint.
If you want to try the CLI without installing it permanently:
uvx --from gotta gotta --help
gotta currently targets Python >=3.13.
If you are developing on the repo, sync a local uv-managed environment:
uv sync --python 3.13 --extra dev
Installed entrypoints:
gotta ...
Development And Quality Gate
The core local gate is:
uv run pytest -q
uv run ruff check src tests
uv run python -m py_compile $(find src tests -name '*.py' -print)
uv run python -m vulture src tests --min-confidence 80
Structural pressure tools are part of the maintenance discipline:
uv run python -m radon cc src tests -s
uv run lizard src tests
uv build --python 3.13 --clear
uvx twine check dist/*
pytest, ruff, py_compile, and vulture are the correctness and hygiene
gate. radon and lizard are not bug finders; they expose responsibility
concentration and complexity hotspots so cleanup removes residue instead of
burying it.
Configuration And Durable State
Durable provider config lives in GOTTA_CONFIG_FILE or, by default, under
gotta's OS-native config directory:
- macOS:
~/Library/Application Support/gotta/gotta.toml - Linux:
~/.config/gotta/gotta.toml - Windows:
%AppData%\\gotta\\gotta.toml
Example:
[providers.atlassian.env]
GOTTA_ATLASSIAN_OAUTH_CLIENT_ID = "your-client-id"
GOTTA_ATLASSIAN_OAUTH_CLIENT_SECRET = "your-client-secret"
GOTTA_ATLASSIAN_OAUTH_REDIRECT_URI = "http://localhost:8080/callback"
GOTTA_ATLASSIAN_TOOLSETS = "all"
GOTTA_JIRA_BASE_URL = "https://example.atlassian.net"
GOTTA_CONFLUENCE_BASE_URL = "https://example.atlassian.net/wiki"
[providers.google.env]
GOTTA_GOOGLE_OAUTH_CLIENT_ID = "your-client-id"
GOTTA_GOOGLE_OAUTH_CLIENT_SECRET = "your-client-secret"
GOTTA_GOOGLE_OAUTH_REDIRECT_URI = "http://localhost:8091/callback"
[providers.slack.env]
GOTTA_SLACK_WORKSPACE = "your-workspace"
Durable OAuth state lands under gotta's OS-native state directory:
- macOS:
~/Library/Application Support/gotta/auth/ - Linux:
~/.local/state/gotta/auth/ - Windows:
%LocalAppData%\\gotta\\auth\\
Canonical Session Model
The canonical top-level root is a session root under gotta's OS-native data directory:
<gotta data dir>/sessions/<session-id>/
Examples:
- macOS:
~/Library/Application Support/gotta/sessions/<session-id>/ - Linux:
~/.local/share/gotta/sessions/<session-id>/
Session roots are context-derived, not mission-name-derived.
Each session root owns:
$WS/
state/
env
bin/
content/
graph.mmd
graph.json
semantic-graph.mmd
semantic-graph.json
summary.json
Stored artifacts have two native reopen handles:
artifact:<preferred-name>@<digest12>content:<sha256>
Both resolve through gotta read ..., so emitted evidence does not require
manual manifest spelunking just to continue.
The content store is first-class:
- the filesystem under
$WS/contentis the durable evidence graph manifest.jsonlis the append-only invocation index- identical bytes land in the same content object
- repeated fetches create additional timestamped evidence links
Retrieval And Materialization
Provider-first usage without work is first-class:
gotta jira status
gotta jira search "retry budget"
gotta github search "service ownership"
gotta github https://github.com/org/repo/commits/HEAD
gotta confluence search "queue architecture"
gotta gdocs search "incident response"
gotta slack workspaces
gotta slack auth
gotta slack search "handoff failure"
gotta read https://github.com/org/repo/blob/main/README.md
Those commands bind or create a session automatically and materialize durable evidence under that session.
gotta read is the canonical retrieval entrypoint. It supports:
- local files and directories
- bounded local rereads through
--head,--tail, and--section - provider URLs routed to the correct plugin
- canonical provider locators emitted by session surfaces
- stored content rereads by artifact or digest
Session Synthesis Surfaces
gotta session is how the raw evidence web becomes navigable:
session manifestsession timelinesession graphsession leadssession analyze
Examples:
gotta session show
gotta session manifest --plugin jira
gotta session timeline --limit 20
gotta session graph --output mermaid
gotta session leads artifact:ticket.md@0123deadbeef
gotta session analyze
These surfaces intentionally compress the evidence web:
manifestsummarizes what has been materializedtimelinereconstructs chronologygraphrenders lineage and continuityleadsextracts explicit next reads from existing artifactsanalyzerebuilds cached session synthesis outputs from durable state
Before the first strong anchor, empty manifest, graph, leads, and
analyze output is normal.
Session Coordination
Scaffold the active session in place, then rewrite the operator-owned charter surfaces explicitly:
gotta session init
gotta want --stdin <<'EOF'
Queue retry investigation.
EOF
gotta goal --stdin <<'EOF'
Build the execution charter for the current session from live context.
EOF
That scaffolds the canonical session files plus readable projections:
$WS/
WANT.md
TODO.md
LOGS.md
GOAL.md
OOPS.md
peers/
bin/
Inside the session surface:
WANT.mdandGOAL.mdare intentional rewritesstate/todo.jsonlis canonical and projects intoTODO.mdstate/logs.jsonlis canonical and projects intoLOGS.mdstate/oops.jsonlis canonical and projects intoOOPS.md- peer lifecycle state, peer notes state, and the session evidence web carry shared coordination
This split is deliberate:
- narrative framing stays editable
- operational truth stays append-only and durable
- readable projections refresh from canonical state
Examples:
gotta session init
gotta want --stdin <<'EOF'
Queue retry investigation.
EOF
gotta goal --stdin <<'EOF'
Investigate retry handling from the first strong source anchor and keep the
charter current as evidence lands.
EOF
gotta todo append <<'EOF'
Inspect duplicate materializations in `gotta session analyze`.
EOF
gotta logs append <<'EOF'
Captured the first GitHub, Jira, and Confluence anchor set.
EOF
gotta oops append <<'EOF'
Search results were followable, but one direct fetch still had a continuity gap.
EOF
Flat Linked Peer Sessions
Peers are linked sessions, not hierarchical sub-objects.
peers/<actor>/is a symlink to that linked peer session rootstate/peers/<actor>/is a symlink to that peer session'sstate/- peer-local planning and lifecycle state stay peer-local
- shared coordination surfaces stay shared by explicit links
Examples:
gotta peer with Claude
gotta want --session peers/claude --stdin <<'EOF'
Trace retry ownership from the first strong source anchor.
EOF
gotta goal --session peers/claude --stdin <<'EOF'
Materialize the peer-local evidence contract before launch.
EOF
gotta peer launch Claude
gotta notes show claude
gotta todo extend --session peers/claude <<'EOF'
- Compare retry behavior across the earliest design docs.
EOF
Important invariants:
gotta peer with ...configures linked peer sessions but does not launch them- peer-local
WANT.mdandGOAL.mdare seeded placeholders that must be rewritten before launch withgotta want --session peers/<peer> ...andgotta goal --session peers/<peer> ... - peer-local
TODO.mdis seeded automatically and can be extended - peer notes are supervisory visibility, not a separate truth store
- peer evidence often lands in the shared manifest, timeline, and graph before notes fully catch up
oops As Canonical Alignment
gotta oops is a first-class operator surface, not an afterthought.
Use it to record:
- broken or misleading contracts
- native surfaces that should have been followable but were not
- provider coverage limits that materially shaped the investigation
- workflow friction that forced unnatural detours
The point is not merely bug tracking. The point is preserving operator-visible misalignment in canonical shared state so the tool can be refined from observed breakage rather than taste or memory.
Plugin Architecture
gotta uses two entry-point groups:
gotta.pluginsfor top-level pluginsgotta.askfor optional ask-family extensions
Core is a PEP 420 namespace package. Plugins can live in separate distributions
and still contribute modules under the shared gotta namespace.
Core currently ships these top-level plugins:
askconfluencegdocsgdrivegithubgsheetsjiralogsnotesoopspeerreadsessionslacktodowantgoal
read is the URL-shaped dispatcher. It routes recognized targets through
installed provider plugins by asking those plugins whether they own the target.
Ask Extensions
gotta ask is a generic host for separately installed ask-family extensions.
Core does not ship any built-in ask surfaces.
An ask extension registers the gotta.ask entry-point group and then becomes
available as:
gotta ask <surface> ...
Use gotta ask --help-all to inspect installed ask surfaces recursively.
Contributing And Release Discipline
The project is maintained with a few deliberate rules:
- remove residue instead of layering over it
- prefer tool-observable truth to conversational assumption
- keep friction canonical in
oops - treat complexity as measurable pressure, not just aesthetic discomfort
If you contribute:
- run the full quality gate before proposing changes
- keep examples and fixtures generic and public
- preserve the native evidence-first workflow
- prefer behavior-level cleanup over compatibility ballast
See CONTRIBUTING.md for the repository baseline.
Release
Build and validate artifacts with uv:
uv build --python 3.13 --clear
uvx twine check dist/*
uv publish --dry-run
uv publish
uv publish needs PyPI credentials in the environment. The simplest local path
is UV_PUBLISH_TOKEN.
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 gotta-0.3.0.tar.gz.
File metadata
- Download URL: gotta-0.3.0.tar.gz
- Upload date:
- Size: 231.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.10.2 {"installer":{"name":"uv","version":"0.10.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b1384057bd58f58dfd60ba7e1888121ddb00e23c32638841a20b17aea1850387
|
|
| MD5 |
0e3df87af257c19a8dc0c2273b810406
|
|
| BLAKE2b-256 |
a05801f3a5385f754ab1d142296df92fae55af5d7300f6ce36207ccef18cbf2d
|
File details
Details for the file gotta-0.3.0-py3-none-any.whl.
File metadata
- Download URL: gotta-0.3.0-py3-none-any.whl
- Upload date:
- Size: 213.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.10.2 {"installer":{"name":"uv","version":"0.10.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9aa3ed7d16cf02ff0e93a635ef72a8f0ab3d5a1bdc08617e71df1f80d547ac0b
|
|
| MD5 |
526b898b721d22f2e0e2ee3d0dc52633
|
|
| BLAKE2b-256 |
5dee9f71d8e4e6e2e15fe0862f452c8ba6a4319fb371ec74f6bf1afa20115fe5
|