Skip to content

CLI command reference

CommandArgumentsBehavior
tyoiNoneSame as run; also handles --help and --version
tyoi create [name]Project nameCreates <cwd>/<name>/ and copies a project template
tyoi init [name]Project nameCopies a project template into the current directory
tyoi configNoneCopies a configuration template into the current directory
tyoi runNoneFinds a configuration file and starts the server
tyoi infoNoneDisplays the configuration produced from the file and CLI options
tyoi setting <key> <value>Setting key and valueSaves CLI settings to .tyoi-server/config.json
tyoi helpNoneDisplays the command list

Project names

Valid names match this regular expression:

text
^[a-zA-Z0-9-]+$

If you omit the name, the CLI uses the current directory name as the initial value and prompts for input.

Configuration file discovery

run and info search the current directory and all directories under config/ for JavaScript files with these names:

text
tyoi.config.js
tyoi.<name>.config.js

<name> may contain letters, numbers, and periods. The config/ directory is searched recursively. TypeScript configuration files are not loaded. If multiple files are found, the CLI asks you to choose from a sorted list.