The command a person types. It reads the code graph the SourceAnt agent keeps on this machine.
$ sourceant repos
REPOSITORY PATH
acme/billing /home/you/work/billing
$ sourceant graph acme/billing
2215 nodes, 2006 links
KIND COUNT
function 895
import 854
class 257
python 179
EDGE COUNT
defines 1152
imports 854
Three processes, each with one job:
sourceant |
this CLI, which talks only to the agent |
sourceant-agent |
always running: supervises the indexer, keeps the graph current, serves it |
| the SourceAnt core | Python, owns the grammars and the graph |
The CLI never reaches past the agent. The agent is the process that is always up and the one that knows where the core is listening; going around it would mean learning both.
curl -fsSL https://raw.githubusercontent.com/sourceant/cli/main/scripts/install.sh | sh
sourceant setupsetup puts the agent and a core on this machine and writes down which one, so the agent knows what to start.
--runtime docker pulls the published image. --runtime python builds a virtual environment and installs the core's published wheel.
The core and agent versions are independent of the CLI version. By default, Docker uses the latest image, Python uses the latest core release, and the agent uses its latest release. Release lookup prefers a stable release and falls back to the newest published prerelease when no stable release exists. The CLI installer uses the same policy.
Pin releases independently:
sourceant setup --core-version 1.0.0-beta.2 --agent-version 1.0.0-beta.2--core-version selects a v-prefixed image tag for Docker or a release wheel for Python. Use --image for a custom container image or --from for a Python package specifier or checkout. Neither can be combined with --core-version.
To pin the CLI installer itself:
curl -fsSL https://raw.githubusercontent.com/sourceant/cli/main/scripts/install.sh | SOURCEANT_VERSION=1.0.0-beta.2 shBoth put the index in the same place, $XDG_DATA_HOME/sourceant, so it does not matter which one indexed it. The container runs as whoever installed, so what it writes there belongs to them.
sourceant ui starts the agent and opens the view. sourceant stop shuts down the agent and its core without removing the index or configuration. Stopping requires an agent with stop support.
| Variable | Default | Meaning |
|---|---|---|
SOURCEANT_AGENT_URL |
http://127.0.0.1:8930 |
The agent to talk to |
--agent, --timeout and --json override it per command.
| Command | What it does |
|---|---|
sourceant setup |
Put the agent and a core on this machine |
sourceant stop |
Stop the agent and its Python core or Docker container |
sourceant status |
Whether the agent and the indexer are running |
sourceant repos |
Repositories indexed on this machine |
sourceant graph <repository> |
What the indexer found in one of them |
sourceant ui |
Open the graph in a browser |
sourceant version |
What this build is |
--json prints the agent's own answer, for anything that wants to read it rather than look at it.
make qa # fmt-check, vet, lint, test
make buildMIT.