sextant init
sextant init writes a starter .sextant/ directory. See the
full guide for templates and
post-init steps; this page is the flag reference.
sextant init [OPTIONS]
Options: --template <TEMPLATE> Which scaffold to drop. Defaults to `default`. [possible values: default, rust, python, go, java, ts, strict] --force Overwrite existing files instead of skipping them. -h, --help Print help.What gets written
Section titled “What gets written”.sextant/├── config.toml # always written if missing└── rules/ # always created └── (template-specific sample rule, if any)config.toml is the only file every template writes. The rules/
directory is created empty for default and strict; language
templates drop one sample rule there.
Idempotency
Section titled “Idempotency”By default, init skips files that already exist. Re-running the
command after editing config.toml won’t lose your changes. Pass
--force to overwrite.
sextant init # bootstrap, skipping existing filessextant init --template rust # add the Rust sample rulesextant init --force # overwrite everythingTemplates
Section titled “Templates”Full template list and what each writes is in Getting started → sextant init.
Exit codes
Section titled “Exit codes”| Code | When |
|---|---|
0 | Files written or skipped successfully. |
2 | Filesystem error, invalid template name, or other CLI failure. |
See also
Section titled “See also”- Getting started → sextant init — walk-through.
- Configuration — what
config.tomlcontrols. - Authoring rules — write your own after init.