# The command line Every command of `samplekit`, as its `--help` gives it. `samplekit COMMAND -h` prints a shorter summary in the terminal. ## General options The options most commands share. Each command below says which of them it takes. - `-v, --verbose`: Also say which files were skipped, and which configuration is used - `-q, --quiet`: Print no warning - `--at `: Read the project as it was at a snapshot of its history WHEN is a number from `samplekit log`, the beginning of a snapshot's id, or a date such as 2026-09-12 or '2026-09-12 14:30'. - `--no-color`: No colour in messages (also NO\_COLOR or TERM=dumb) - `--rc `: Use this .samplekitrc instead of the nearest one - `--show-rc`: Print the configuration and model a command would use - `-h, --help`: Print help; -h for a compact summary - `-V, --version`: Print version ## samplekit Sample data in plain Markdown: computed, current, tracked Find, show, check, compute, export and plot the samples of a project. Given files or a folder and no table options, samplekit prints the path of each sample selected; -c or --profile shows a table instead. Alone at a terminal, samplekit opens the TUI; elsewhere it prints this help. Paths and options may come before the command or after it: samplekit samples status and samplekit status samples read the same. The first word naming a command is the command, even where a file or a folder has its name: write that one status/ or ./status, or after the command. ```text samplekit [TARGET] [OPTIONS] samplekit [TARGET] [OPTIONS] ``` Commands: - [`list`](#samplekit-list): List fields, tags and what .samplekitrc declares - [`status`](#samplekit-status): Show which computed values are not current, and why - [`compute`](#samplekit-compute): Compute the values the project's model gives - [`explain`](#samplekit-explain): Explain where one value came from - [`open`](#samplekit-open): Open a sample's own files (images, reports) or the folder holding them - [`view`](#samplekit-view): Show each selected sample whole: its values, then its tables; --note adds the note - [`export`](#samplekit-export): Preview an export declared in .samplekitrc, a table or a figure; --write writes it - [`plot`](#samplekit-plot): Draw a figure with matplotlib, in a window or to a file - [`run`](#samplekit-run): Run a script the model declares on each sample, or the selection; what it changes is shown and asked - [`validate`](#samplekit-validate): Report the defects of sample files; nothing is changed - [`tag`](#samplekit-tag): Add, remove or rename tags - [`log`](#samplekit-log): List the snapshots of the project's history - [`diff`](#samplekit-diff): Compare two states of the project, value by value - [`restore`](#samplekit-restore): Put files back as the history kept them: the last change taken back, or a state named - [`remove`](#samplekit-remove): Delete sample files; the history keeps them, and restore gives them back - [`rename`](#samplekit-rename): Rename a sample, its own files with it, and the links leading to it - [`init`](#samplekit-init): Set up a project, or complete one that exists - [`new`](#samplekit-new): Create a sample from what the project already knows - [`set`](#samplekit-set): Change values of a sample - [`tui`](#samplekit-tui): Open the TUI, the full-screen interface, on a folder; `samplekit` alone opens its start page - `help`: Print this message or the help of the given subcommand(s) Arguments: - `[TARGETS]...`: Sample files or folders; the current folder when an option is given Selection: - `-f, --filter `: Keep the samples an expression selects. Repeatable: every --filter and every --query must hold. elongation \> 20, material == steel, material == "cast iron", tensile\_strength \> yield\_strength, material in (steel, copper), tags has reference, curve where (strain \> 1 && stress \< 300), elongation is missing. Combine with &&, \|\| and ! and parentheses, and quote the whole expression for the shell. Every form: https://zelyph.github.io/SampleKit/latest/reference/filters.html - `--query `: Keep the samples a query saved in .samplekitrc selects. Repeatable: every --filter and every --query must hold - `-s, --sort `: Sort by these fields, the first deciding first; repeat or comma-separate. A leading - sorts that field in descending order: -s material,-tensile\_strength - `-r, --reverse`: Reverse the sort Shape: - `-c, --columns `: Columns as FIELD\[:PRECISION\]\[=NAME\]; repeat or comma-separate. NAME titles the column on the terminal and in a document, and names its columns in a CSV, TSV or JSON file: young\_modulus=E writes E\_value and E\_uncertainty. A NAME holding a comma is quoted: young\_modulus='Modulus, E' - `--profile `: Show the table a profile declared in .samplekitrc gives. It sets the columns, the order, the groups and the precision, and each option written beside it overrides its part: -c the columns, -s the order, --group the groups, --precision the digits - `--summary`: Summarise each column instead of listing the samples - `--group `: One table per value of these fields, comma-separated, or per combination of values; with --summary, a summary per group Presentation: - `--style