CLI Reference
Complete reference for all Blade commands.
blade
Launch the Blade terminal emulator.
Usage
blade [OPTIONS]
Options
| Flag | Description |
|---|---|
--config <path> | Path to a custom config file (default: platform config directory) |
--version | Print version information and exit |
--help | Print help information |
Examples
# Launch with default config
$ blade
# Launch with custom config
$ blade --config ~/my-blade.toml
# Check version
$ blade --version
blade 1.0.0
blade doctor
Run system diagnostics to check GPU, fonts, config, and PTY health.
Usage
blade doctor
Example output
$ blade doctor
Blade Diagnostics
GPU NVIDIA RTX 4090 (Vulkan 1.3)
Font MiSans (ligatures: on)
PTY ConPTY v2.0 (Windows 11)
Render 144 FPS (vsync, 2 draw calls)
Latency 2.3ms (input-to-pixel)
All checks passed
If any check fails, blade doctor will print a specific error message and suggest a fix. See Troubleshooting for common issues.
blade serve
Start the Blade daemon for remote access and multiplayer sessions.
Usage
blade serve [OPTIONS]
Options
| Flag | Description |
|---|---|
--port <port> | WebSocket server port (default: 9001) |
--host <addr> | Bind address (default: 0.0.0.0) |
Example
$ blade serve
Blade daemon started
WebSocket: wss://192.168.1.100:9001
Web client: https://192.168.1.100:9001/client
QR code displayed below...
blade install
Install plugins, themes, or keybinding packs from the BladeHub registry.
Usage
blade install <type> <name>
Types
| Type | Description |
|---|---|
theme | Color theme package |
keybindings | Keybinding preset pack |
plugin | Plugin extension |
shader | Custom shader extension |
Examples
# Install a theme
$ blade install theme catppuccin
Installed catppuccin v1.2.0
# Install a keybinding pack
$ blade install keybindings vim-extended
Installed vim-extended v0.3.1
blade search
Search the BladeHub registry for available packages.
Usage
blade search [query]
Example
$ blade search theme
catppuccin v1.2.0 Catppuccin color schemes
gruvbox v0.9.0 Gruvbox dark and light themes
rose-pine v1.0.1 Rose Pine color palette
one-dark v0.8.2 Atom One Dark port