init
Scaffold a starter project from a template into a directory.
Destructive action
This command modifies or deletes data irreversibly.
Scaffolds a starter project from one of the CLI's built-in templates into a directory. It is fully
local — the templates are embedded in the binary, so there is no network call. Give it a template
id and, optionally, a target dir (defaults to the current directory); it copies the template's files
into place and reports exactly which files it created.
Use it to bootstrap a new working tree with a sensible layout and example definitions instead of
starting from an empty folder. By default it refuses to write into a non-empty directory and exits 2;
pass --force to overwrite anyway. An unknown template id also exits 2 and points you at
simetrik samples.
To see which template ids are available before running this, run simetrik samples.
See also: samples. Requires CLI access. See permissions.
Arguments
template— Template id to scaffold (seesimetrik samples)dir(optional) — Target directory (defaults to the current directory)
Flags
--force— Overwrite the target directory even if it is not empty
Examples
simetrik init basic-recon
simetrik init basic-recon ./my-project
simetrik init basic-recon ./my-project --forceExit codes
| Code | Meaning |
|---|---|
0 | Template scaffolded into the target directory |
2 | Usage error — unknown template id, or the target directory is not empty (pass --force) |