Commands

The program is called entity. Run these from a republic's folder as node cli/index.js COMMAND, or as entity COMMAND once you have the shortcut from Getting started.

§01By task

Starting: found, preset, join, key
Everyday: act, propose, count, settle, status, params, participants, verify
Copies: sync, bundle, absorb, clone, radicle, attest
Changing the code or the law: module, upgrade, adopt, gate, fork
Checkpoints: checkpoint, finality
Running a node: serve, build, dist
When something is wrong: diagnose, repair

§02All commands

Command	What it does	Usage
`entity found`	bring it into being	`[--preset name] [--id p-0001] [--name "…"]`
`entity act`	do something, signed	`<kind> [--field value …] [--as id] [--out file] [--settle]`
`entity settle`	fold pending acts into the record [--dry]
`entity verify`	check it, offline, needing nobody [--json]
`entity sync`	push and pull everywhere at once [--to name] [--settle]
`entity propose`	lay a proposal, rule chosen for you --title "…" [--effects json] [--changes json]
`entity join`	make a key and sign an application --id <id> [--name "…"]
`entity key`	show or rotate your key	`show \	rotate`
`entity seal`	sealed content only members read	`status \	key \	epoch \	grant M \	post \	read`
`entity password`	sign in with a password	`set \	remove [--as id] [--settle]`
`entity status`	what this copy holds
`entity count`	count the ballots on a proposal	`<proposal id> [--json]`
`entity params`	every settable value	`[key]`
`entity participants`	the register
`entity preset`	shapes to found from	`list \	apply <name>`
`entity attest`	sign what you hold
`entity checkpoint`	signed positions	`status \	make \	sign [n] \	tidy`
`entity bundle`	the record as one file	`[--out file] [--from n]`
`entity absorb`	fold in a bundle or signed act	`<file> [--settle]`
`entity clone`	a new copy from any holder	`<bundle \	url> <dir>`
`entity diagnose`	describe damage to the record
`entity repair`	rechain after concurrent appends [--merge bundle] [--resettle] [--write]
`entity module`	modules, by decision	`list \	available \	source [src] \	add <n> \	upgrade <n> \	enable <n> \	disable <n> \	fetch`
`entity finality`	checkpoints that decide	`status \	sign \	evidence <file> \	scan <copy>`
`entity upgrade`	the core, by decision	`check [source] \	propose [source] \	apply \	status`
`entity fork`	a new entity naming this one as its parent --name "…" --out <dir> --as <id> [--at n] [--carry value,deeds] [--electorate spec]
`entity radicle`	publish and replicate on Radicle	`init \	status`
`entity adopt`	bring in approved code or law	`<git ref> [--decision <id>] [--dry]`
`entity gate`	may these files change?	`<paths…> --decision <id> \	--against <dir> \	digest <paths…>`
`entity serve`	run a node and its page	`[--port 7780] [--settle]`
`entity app`	the local control panel: create and run republics in a browser [--port 7700] [--home ~/entities]
`entity build`	the static page	`[--out site]`
`entity dist`	the code as an archive, never the state [--out file]

§03Options every command takes

--dir <entity directory> --as <participant id> --key <private key file>

--dir works on an entity in another folder.
--as signs as that member; their key is found in ~/.entity/keys/<entity id>/<id>, or set ENTITY_KEYS to keep keys elsewhere.
--key uses a key file anywhere; --password (or ENTITY_PASSWORD) signs with your password instead.

§04Only from the terminal

Most things happen on the page. These need the terminal: founding (preset apply, found); setting the module source (module source); second readings of constitutional changes (act proposal.lay … --reading_of); copies and repair (sync, bundle, absorb, clone, fork, diagnose, repair, radicle init); key rotation (key rotate); and a node's own settings in node.json.