CLI Reference

ℹ Info: Jump to specific commands:

zith check - Check code for errors
zith compile - Compile to binary
zith build - Build project
zith run - Run program directly
zith new - Create new project
zith fmt - Format code

Overview

The Zith CLI provides all the tools you need to develop, build, and run Zith programs. Each command is designed to be intuitive and follow Unix conventions.

Command Structure

All Zith commands follow this pattern:

zith <command> [options] [arguments]

Global Flags

These flags work with all commands:

Flag	Description	Default
`--help`, `-h`	Show help message	-
`--version`, `-v`	Show version info	-
`--verbose`	Enable verbose output	`false`
`--config`	Specify config file	`ZithProject.toml`

Available Commands

Development Workflow

Quick Reference Table

Command	Purpose	Typical Use Case
`new`	Create new project	Starting a fresh project
`check`	Static analysis	Before committing code
`compile`	Generate binary	Production builds
`build`	Full build pipeline	Development workflow
`run`	Compile and execute	Quick testing
`fmt`	Format code	Before commits
`repl`	Interactive shell	Experimentation
`clean`	Remove build artifacts	Cleanup
`docs`	Generate documentation	Building docs

💡 Tip: Use zith --help for detailed information about any command.

Next Steps

Learn about individual commands in the sidebar
Read about global flags
Set up your project configuration