Skip to content

Command-line Flags

HUME's command line is deliberately small — almost everything is configured in init.scm rather than passed as a flag. This page covers the hume command as run from a shell; for the in-editor : prompt, see Commands.

Synopsis

sh
hume [OPTIONS] [FILE...]

Arguments

ArgumentDescription
FILE...One or more files to open. With no arguments, HUME opens a scratch buffer named *scratch*.

Options

FlagDescription
--keys <STREAM>Headless golf-replay mode. Replay the key STREAM (e.g. dwx) against a single input file and write the result to --output. Requires --output and exactly one FILE.
--output <PATH>Output path for headless mode. Required by and requires --keys.
-h, --helpPrint help and exit.
-V, --versionPrint the HUME version (e.g. hume 0.9.0-f460770) and exit. The same string is available inside the editor via :version.

What's not here

HUME has no flags for overriding the config path, log level, theme, or tutor. Configuration lives in init.scm (see Configuration); the runtime directory can be redirected with the HUME_RUNTIME environment variable; logging is in-memory only and surfaced via :messages (see Files & Buffers).

Examples

sh
hume README.md                # open a file
hume src/a.rs src/b.rs        # open multiple files
hume                          # scratch buffer
hume --version
hume --keys 'dwwx' --output out.txt in.txt   # headless replay

Released under the MIT License.