tatbot command reference¶

Offline CLI workflows for public development and replay. Maintainers can inspect the complete machine-readable schema with tatbot schema --json.

tatbot [global flags] <noun> [verb] [args] [-- passthrough args]

Global flags may appear anywhere before the first --, as --flag value or --flag=value, unless a declared command option owns that spelling: --json, --dry-run, --explain, -q, -v. Stating one twice with different values is a usage error.

--json execution is supported only by commands declaring structured output in schema --json; all commands support JSON plans and explanations. Backend flags on structured commands require --; tokens after it are preserved.

CLI-owned exit codes are below. Executed backends and SSH retain their own exit codes and error output; backend failures are not remapped to 1.

Exit codes¶

code

meaning

0

ok

1

underlying tool failed

2

usage error

3

safety gate refused

4

wrong node for this verb

5

hardware unreachable

6

busy

Safety tiers¶

tier

meaning

gates

offline

files only

—

Verbs¶

tatbot completion — generate opt-in shell completion¶

verb

tier

runs on

wraps

summary

completion bash

offline

this checkout

native

print Bash completion generated from canonical command metadata

tatbot body — immutable human body model assets and cache audit¶

verb

tier

runs on

wraps

summary

body bootstrap

offline

this checkout

native

copy a pinned, pre-downloaded MHR and SOMA allowlist into an explicit verified cache

body audit

offline

this checkout

native

read and hash every byte in an explicit MHR and SOMA cache without deserializing it

tatbot teleop — leader→follower teleoperation¶

verb

tier

runs on

wraps

summary

teleop poses

offline

this checkout

scripts/vision/teleop_poses.py

export measured follower tip poses and host read timestamps from a flight log (--ee-tool)

teleop analyze

offline

this checkout

cpp/teleop/analyze_log.py

loop-timing stats from a .wxtl without a GUI

tatbot rollout — offline checks of a trained policy: its contract, its action plausibility¶

verb

tier

runs on

wraps

summary

rollout bench

offline

this checkout

scripts/eval/trajectory_plausibility.py

no-robot plausibility check of a policy’s action chunks (-- → trajectory_plausibility.py)

rollout contract

offline

this checkout

scripts/eval/checkpoint_contract.py

the input/action contract stored with a checkpoint (-- → checkpoint_contract.py)

tatbot calib — native arm measurements and retained overhead registration¶

verb

tier

runs on

wraps

summary

calib register-fit

offline

this checkout

scripts/vision/native_registration.py

fit an unadopted overhead registration from original native holds and shared geometry

tatbot vision — offline vision processing and calibration¶

verb

tier

runs on

wraps

summary

vision depth compare

offline

this checkout

scripts/vision/depth_compare.py

compare filters on a retained raw scan burst

vision stencil generate

offline

this checkout

scripts/lib/stencil_generate.py, scripts/lib/stencil_tile.py

generate the skin stencil: a fiducial tile of AprilTag 16h5 markers with its 300 dpi print

vision stencil reference

offline

this checkout

scripts/lib/stencil_reference.py

export a tracking manifest for a generated fiducial tile, and install it where the observer reads

vision tags print

offline

this checkout

scripts/vision/generate_wrist_tags.py

render the wrist-tag print sheet (-- → generate_wrist_tags.py)

vision handeye d405

offline

this checkout

scripts/vision/d405_handeye_plane.py

plane-route hand-eye for the wrist D405s: fit depth planes against the touched-off paper (-- → d405_handeye_plane.py)

tatbot drawingbot — DrawingBotV3 stroke experiments and preference review¶

verb

tier

runs on

wraps

summary

drawingbot generate

offline

this checkout

scripts/drawingbot.sh, scripts/drawingbot.py, scripts/lib/drawing_python.sh, scripts/lib/drawing_python.py, scripts/lib/drawingbot/artifacts.py, scripts/lib/drawingbot/bridge.py, scripts/lib/drawingbot/replay.py, scripts/lib/drawingbot/recipe.py, scripts/lib/drawingbot/container.py, scripts/lib/drawingbot/job.py, scripts/lib/drawingbot/pens.py

generate one physical DBV3 drawing with verified settings and a saved native recipe

drawingbot export

offline

this checkout

scripts/drawingbot.sh, scripts/drawingbot.py, scripts/lib/drawing_python.sh, scripts/lib/drawing_python.py, scripts/lib/drawingbot/artifacts.py, scripts/lib/drawingbot/bridge.py, scripts/lib/drawingbot/replay.py, scripts/lib/drawingbot/recipe.py, scripts/lib/drawingbot/container.py

verify and replay native SVG acquisition only, without ROS compilation

drawingbot container

offline

this checkout

scripts/drawingbot.sh, scripts/drawingbot.py, scripts/lib/drawing_python.sh, scripts/lib/drawing_python.py, scripts/lib/drawingbot/artifacts.py, scripts/lib/drawingbot/bridge.py, scripts/lib/drawingbot/replay.py, scripts/lib/drawingbot/recipe.py, scripts/lib/drawingbot/container.py

build, smoke-test or run the private mounted-app acquisition container

tatbot inkmap — ground InkLang placements and preview tattoos on canonical bodies¶

verb

tier

runs on

wraps

summary

inkmap dev

offline

this checkout

scripts/inkmap_dev.sh, web/inkmap/package.json

the tattoo preview app on this machine (-- → inkmap_dev.sh)

inkmap resolve

offline

this checkout

web/inkmap/tools/resolve.ts, config/inkmap/inklang-resolution.schema.json, web/inkmap/package.json

resolve InkLang placement text to a canonical rest-surface anchor as JSON

tatbot profile — inspect and validate hardware profiles¶

verb

tier

runs on

wraps

summary

profile show

offline

this checkout

scripts/lib/tatbot_profile.py

the resolved hardware profile: backend, arms, e-stop, provenance

profile list

offline

this checkout

scripts/lib/tatbot_profile.py

the profiles this checkout carries

profile check

offline

this checkout

scripts/lib/tatbot_profile.py

can the resolved profile drive hardware? (exit 3 if not)

tatbot art — palette-aware design: ink gamut, predicted appearance and minutes¶

verb

tier

runs on

wraps

summary

art swatch

offline

this checkout

scripts/art.sh, scripts/art.py, scripts/lib/drawing_python.sh, scripts/lib/drawing_python.py, python/tatbot_art/src/tatbot_art/cli.py, python/tatbot_art/src/tatbot_art/inks.py, python/tatbot_art/src/tatbot_art/gamut.py, python/tatbot_art/src/tatbot_art/swatch.py

the achievable-palette sheet: every tint and two-ink hatch mix a palette load can draw

art render

offline

this checkout

scripts/art.sh, scripts/art.py, scripts/lib/drawing_python.sh, scripts/lib/drawing_python.py, python/tatbot_art/src/tatbot_art/cli.py, python/tatbot_art/src/tatbot_art/inks.py, python/tatbot_art/src/tatbot_art/render.py, python/tatbot_art/src/tatbot_art/raster.py, python/tatbot_art/src/tatbot_art/timing.py

predicted appearance of a program as ink on a substrate, with dips, rinses and minutes

art profile

offline

this checkout

scripts/art.sh, scripts/art.py, scripts/lib/drawing_python.sh, scripts/lib/drawing_python.py, python/tatbot_art/src/tatbot_art/cli.py, python/tatbot_art/src/tatbot_art/inks.py, python/tatbot_art/src/tatbot_art/profile.py, python/tatbot_art/src/tatbot_art/timing.py

drawing, descent, lift, travel, dipping and rinse time from a saved compiled program

art separate

offline

this checkout

scripts/art.sh, scripts/art.py, scripts/lib/drawing_python.sh, scripts/lib/drawing_python.py, python/tatbot_art/src/tatbot_art/cli.py, python/tatbot_art/src/tatbot_art/inks.py, python/tatbot_art/src/tatbot_art/separate.py, python/tatbot_art/src/tatbot_art/acquire.py, python/tatbot_art/src/tatbot_art/offset.py, python/tatbot_art/src/tatbot_art/pipeline.py, python/tatbot_art/src/tatbot_art/brief.py

a flat-colour image into per-ink DBV3 layers, a compiled program and a predicted render

art tiles

offline

this checkout

scripts/art.sh, scripts/art.py, scripts/lib/drawing_python.sh, scripts/lib/drawing_python.py, python/tatbot_art/src/tatbot_art/cli.py, python/tatbot_art/src/tatbot_art/inks.py, python/tatbot_art/src/tatbot_art/tiles.py, python/tatbot_art/src/tatbot_art/pipeline.py, python/tatbot_art/src/tatbot_art/loop.py

a round composed for a stencil tile, each design separated at its size and compiled onto the print

art stock-renders

offline

this checkout

scripts/art.sh, scripts/art.py, scripts/lib/drawing_python.sh, scripts/lib/drawing_python.py, python/tatbot_art/src/tatbot_art/cli.py, python/tatbot_art/src/tatbot_art/inks.py, python/tatbot_art/src/tatbot_art/brief.py, python/tatbot_art/src/tatbot_art/pipeline.py

Inkmap’s robot renders of its stock designs, each through DBV3 at its width

art tone

offline

this checkout

scripts/art.sh, scripts/art.py, scripts/lib/drawing_python.sh, scripts/lib/drawing_python.py, python/tatbot_art/src/tatbot_art/cli.py, python/tatbot_art/src/tatbot_art/inks.py, python/tatbot_art/src/tatbot_art/tone.py

measure the hatch fill’s grey-to-coverage response with a DBV3 step wedge

art shade

offline

this checkout

scripts/art.sh, scripts/art.py, scripts/lib/drawing_python.sh, scripts/lib/drawing_python.py, python/tatbot_art/src/tatbot_art/cli.py, python/tatbot_art/src/tatbot_art/inks.py, python/tatbot_art/src/tatbot_art/shade.py, python/tatbot_art/src/tatbot_art/cartridge.py, python/tatbot_art/src/tatbot_art/render.py, ros/tatbot_motion/tatbot_motion/estimate.py

a tone image as whip strokes or pendulum zigzags whose deposition fades with the tone, rendered

art wall

offline

this checkout

scripts/art.sh, scripts/art.py, scripts/lib/drawing_python.sh, scripts/lib/drawing_python.py, python/tatbot_art/src/tatbot_art/cli.py, python/tatbot_art/src/tatbot_art/inks.py, python/tatbot_art/src/tatbot_art/loop.py

a round’s designs as voting-wall documents: genes, views, minutes and fidelity

art propose

offline

this checkout

scripts/art.sh, scripts/art.py, scripts/lib/drawing_python.sh, scripts/lib/drawing_python.py, python/tatbot_art/src/tatbot_art/cli.py, python/tatbot_art/src/tatbot_art/inks.py, python/tatbot_art/src/tatbot_art/loop.py

the next round’s Flow prompts from the wall’s votes: the best genes, plus some untried ones

art map

offline

this checkout

scripts/art.sh, scripts/art.py, scripts/lib/drawing_python.sh, scripts/lib/drawing_python.py, python/tatbot_art/src/tatbot_art/cli.py, python/tatbot_art/src/tatbot_art/inks.py, python/tatbot_art/src/tatbot_art/atlas.py, python/tatbot_art/src/tatbot_art/pyramid.py

the voting wall’s map: designs placed by genes and look, clustered, linked to their nearest

art promote

offline

this checkout

scripts/art.sh, scripts/art.py, scripts/lib/drawing_python.sh, scripts/lib/drawing_python.py, python/tatbot_art/src/tatbot_art/cli.py, python/tatbot_art/src/tatbot_art/inks.py, python/tatbot_art/src/tatbot_art/pyramid.py, python/tatbot_art/src/tatbot_art/pipeline.py

the design pyramid’s next pass: draw kept sketches, study kept drawings in every fill

art bundle

offline

this checkout

scripts/art.sh, scripts/art.py, scripts/lib/drawing_python.sh, scripts/lib/drawing_python.py, python/tatbot_art/src/tatbot_art/cli.py, python/tatbot_art/src/tatbot_art/inks.py, python/tatbot_art/src/tatbot_art/bundle.py, python/tatbot_art/src/tatbot_art/acquire.py

drawn designs as reviewable bundles: the acquired layers, their ink loads, program and render

tatbot lab — studies of what the rig can tattoo: trials, cells, plans and camera readings¶

verb

tier

runs on

wraps

summary

lab new

offline

this checkout

scripts/lab.sh, scripts/lab.py, scripts/lib/drawing_python.sh, scripts/lib/drawing_python.py, python/tatbot_lab/src/tatbot_lab/cli.py, python/tatbot_lab/src/tatbot_lab/store.py, python/tatbot_contracts/src/tatbot_contracts/lab.py, python/tatbot_lab/src/tatbot_lab/tile.py

a study: its question, print, cartridges, inks, caps and the bounds of each setting

lab propose

offline

this checkout

scripts/lab.sh, scripts/lab.py, scripts/lib/drawing_python.sh, scripts/lib/drawing_python.py, python/tatbot_lab/src/tatbot_lab/cli.py, python/tatbot_lab/src/tatbot_lab/store.py, python/tatbot_contracts/src/tatbot_contracts/lab.py, python/tatbot_lab/src/tatbot_lab/propose.py, python/tatbot_lab/src/tatbot_lab/space.py, python/tatbot_lab/src/tatbot_lab/search.py

trials from a JSON-lines file, a cartridge’s characterization card, or the search

lab map

offline

this checkout

scripts/lab.sh, scripts/lab.py, scripts/lib/drawing_python.sh, scripts/lib/drawing_python.py, python/tatbot_lab/src/tatbot_lab/cli.py, python/tatbot_lab/src/tatbot_lab/store.py, python/tatbot_contracts/src/tatbot_contracts/lab.py, python/tatbot_lab/src/tatbot_lab/search.py

each archive’s bins of darkness and its second descriptor, and the elite trial of each

lab plan

offline

this checkout

scripts/lab.sh, scripts/lab.py, scripts/lib/drawing_python.sh, scripts/lib/drawing_python.py, python/tatbot_lab/src/tatbot_lab/cli.py, python/tatbot_lab/src/tatbot_lab/store.py, python/tatbot_contracts/src/tatbot_contracts/lab.py, python/tatbot_lab/src/tatbot_lab/plan.py, python/tatbot_lab/src/tatbot_lab/patterns.py, python/tatbot_lab/src/tatbot_lab/tile.py, ros/tatbot_ink/tatbot_ink/program.py

proposed trials into runs on a sheet: programs, the draw commands and cell manifests

lab status

offline

this checkout

scripts/lab.sh, scripts/lab.py, scripts/lib/drawing_python.sh, scripts/lib/drawing_python.py, python/tatbot_lab/src/tatbot_lab/cli.py, python/tatbot_lab/src/tatbot_lab/store.py, python/tatbot_contracts/src/tatbot_contracts/lab.py

each study’s trials by status, its plans and the cells used on each sheet

lab capture

motion-auto

this checkout

scripts/lab.sh, scripts/lab.py, scripts/lib/drawing_python.sh, scripts/lib/drawing_python.py, python/tatbot_lab/src/tatbot_lab/cli.py, python/tatbot_lab/src/tatbot_lab/store.py, python/tatbot_contracts/src/tatbot_contracts/lab.py, scripts/lib/tatbot_cli/tatbot_ros.py, ros/tatbot_session/tatbot_session/views.py

a run’s cells photographed by the overhead and every wrist camera from a hold over each (tatbot ros views)

lab run

motion-auto

this checkout

scripts/lab.sh, scripts/lab.py, scripts/lib/drawing_python.sh, scripts/lib/drawing_python.py, python/tatbot_lab/src/tatbot_lab/cli.py, python/tatbot_lab/src/tatbot_lab/store.py, python/tatbot_contracts/src/tatbot_contracts/lab.py, scripts/lib/tatbot_cli/tatbot_ros.py, ros/tatbot_session/tatbot_session/views.py

one planned run on the rig: its cells photographed before, drawn, photographed after, and read

lab read

offline

this checkout

scripts/lab.sh, scripts/lab.py, scripts/lib/drawing_python.sh, scripts/lib/drawing_python.py, python/tatbot_lab/src/tatbot_lab/cli.py, python/tatbot_lab/src/tatbot_lab/store.py, python/tatbot_contracts/src/tatbot_contracts/lab.py, python/tatbot_lab/src/tatbot_lab/read/__init__.py, python/tatbot_lab/src/tatbot_lab/read/frames.py, python/tatbot_lab/src/tatbot_lab/read/diff.py, python/tatbot_lab/src/tatbot_lab/read/measure.py, scripts/vision/fiducials/stencil.py

a drawn run’s cells from before and after frames: darkening, carry, fade, bands, speckle

Bash completion¶

Generate and source completion explicitly (Bash 4+):

tatbot completion bash > /tmp/tatbot-completion.bash
source /tmp/tatbot-completion.bash

Generation prints shell code; it does not install anything or edit shell startup files. Completion is generated from the canonical commands, options and choices.

Examples¶

tatbot completion bash
tatbot body bootstrap --spec config/body-models/mhr-soma-v1.json --cache-dir '<path>' --source-dir '<path>'
tatbot body audit --spec config/body-models/mhr-soma-v1.json --cache-dir '<path>'
tatbot teleop poses flight.wxtl --out '<path>' --urdf urdf/tatbot.urdf --workspace config/workspace.yaml
tatbot teleop analyze '<path>'
tatbot rollout bench plausibility -- --help
tatbot rollout contract '<path>'
tatbot calib register-fit --python '<path>' --arm pink --capture '<path>' --bundle '<path>' --setup-id table-setup --out '<path>'
tatbot vision depth compare --capture capture-1.npz --settings filters.json
tatbot vision stencil generate --preset silicone --seed 0 --output '<path>'
tatbot vision stencil reference --settings stencil/settings.json
tatbot vision tags print -- --help
tatbot vision handeye d405 --self-test
tatbot drawingbot generate '<path>' --out '<path>' --app '<path>'
tatbot drawingbot export '<path>' --out '<path>' --app '<path>'
tatbot drawingbot container build --out '<path>'
tatbot inkmap dev
tatbot inkmap resolve --prompt 'left upper inner forearm'
tatbot profile show
tatbot profile list
tatbot profile check
tatbot art swatch --inks golden_yellow,bright_red,light_green,light_purple,true_black --out '<path>'
tatbot art render '<path>' --substrate skin-3 --out '<path>'
tatbot art profile '<path>' --out '<path>'
tatbot art separate flash.png --inks golden_yellow,bright_red,light_green,blue_sky,true_black --width-mm 60 --out '<path>' --app '<path>'
tatbot art tiles --plan '<path>' --corpus '<path>' --stencil '<path>' --out '<path>' --app '<path>'
tatbot art stock-renders --app '<path>' --out '<path>'
tatbot art tone --app '<path>' --out '<path>'
tatbot art shade '<path>' --width-mm 30 --technique pendulum --tool '<tool-id>' --out '<path>'
tatbot art wall --round 1 --plan '<path>' --corpus '<path>' --assets '<path>' --out '<path>'
tatbot art propose --designs '<path>' --votes '<path>' --round 2 --out '<path>'
tatbot art map --designs '<path>' --corpus '<path>' --out '<path>'
tatbot art promote --designs '<path>' --votes '<path>' --corpus '<path>' --out '<path>'
tatbot art bundle --votes '<path>' --corpus '<path>' --out '<path>'
tatbot lab new --id card-3rl --question 'What does the 3RL lay at each depth?' --stencil '<path>' --cartridges '<tool-id>' --inks true_black,bright_red --palette true_black=inkcap_large_2,bright_red=inkcap_medium_1,water=inkcap_large_1 --bound trim_mm=-2.5:-1.0 --bound speed_mm_s=2.5:6
tatbot lab propose card-3rl --card '<tool-id>'
tatbot lab map card-3rl
tatbot lab plan card-3rl --stencil '<path>' --sheet bef888-a
tatbot lab status card-3rl
tatbot lab capture card-3rl --plan p0001 --run run-01 --side before
tatbot lab run card-3rl --plan p0001 --run run-01 --stencil '<path>' --sheet-at=400,-100
tatbot lab read card-3rl --plan p0001 --run run-01 --stencil '<path>'