Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.hyperterse.com/llms.txt

Use this file to discover all available pages before exploring further.

All commands load .env files from the working directory when present. 
hyperterse [command] [flags]
​
--version
boolean
Print the installed version and exit.

​
hyperterse start

Read config, validate the project, package tool scripts, open database connections, and start the HTTP server (MCP and optional A2A routes). 
hyperterse start [path] [flags]
Without arguments, loads .hyperterse from the current directory. A positional path can point to a directory containing .hyperterse or directly to a config file.

​
Flags

​
--port
string
default:""
Server port. Overrides config and PORT env var.Short: -pResolution order: --port → server.port → PORT env → 8080
​
--log-level
integer
default:"0"
Log verbosity. 1 = error, 2 = warn, 3 = info, 4 = debug. Overrides config.Resolution order: --verbose (4) → --log-level → server.log_level → 3
​
--verbose
boolean
default:"false"
Sets log level to 4 (debug). Overrides --log-level.
​
--source
string
default:""
Configuration as an inline YAML string instead of reading from a file.Short: -s
​
--watch
boolean
default:"false"
Hot-reload on .terse and .ts file changes. Recompiles and restarts automatically.
​
--log-tags
string
default:""
Comma-separated tag filter. Prefix a tag with - to exclude it.
​
--log-file
boolean
default:"false"
Stream logs to /tmp/.hyperterse/logs/ in addition to stdout.

​
Examples

hyperterse start
hyperterse start --watch
hyperterse start path/to/project
hyperterse start -p 9090 --verbose

​
hyperterse serve

Boot from a pre-built manifest without re-parsing source files. 
hyperterse serve [manifest-or-dir] [flags]
Without arguments, searches for model.bin in the current directory. A positional argument can point to a directory containing model.bin or directly to a manifest file.

​
Flags

​
--port
string
default:""
Server port. Overrides the value embedded in the manifest and PORT env var.Short: -p
​
--log-level
integer
default:"0"
Log verbosity. Overrides the value embedded in the manifest.
​
--verbose
boolean
default:"false"
Sets log level to 4 (debug).
​
--log-tags
string
default:""
Comma-separated tag filter.
​
--log-file
boolean
default:"false"
Stream logs to file.

​
Examples

hyperterse serve dist/
hyperterse serve

​
hyperterse build

Compile the project into a deployable output directory. 
hyperterse build [path] [flags]
Without arguments, loads .hyperterse from the current directory.

​
Flags

​
--out
string
default:"dist"
Output directory for build artifacts.Short: -o
​
--clean-dir
boolean
default:"false"
Remove the output directory before building.

​
Output

dist
hyperterse
model.bin
build
vendor.js
tools
<name>
handler.js
input_transform.js
output_transform.js

​
Examples

hyperterse build
hyperterse build -o release --clean-dir
hyperterse build path/to/project -o dist

​
hyperterse validate

Check configuration and project structure without starting the server. 
hyperterse validate [path] [flags]

​
Flags

​
--source
string
default:""
Configuration as an inline YAML string instead of reading from a file.Short: -s

​
Checks

  • Root config schema compliance
  • Adapter completeness (connector and connection_string required)
  • Tool validity (exactly one of use or handler)
  • Adapter name uniqueness
  • Input type correctness
  • Script file resolution
  • Bundle compilation

​
Exit codes

CodeMeaning
0Validation passed
1Validation failed — errors printed to stderr

​
Examples

hyperterse validate
hyperterse validate path/to/project

​
hyperterse init

Scaffold a new project with starter files. 
hyperterse init

​
Created files

PathContent
.hyperterseRoot config with defaults
app/tools/hello-world/config.terseHello world script-backed tool
app/tools/hello-world/handler.tsTypeScript handler
.agents/skills/hyperterse-docs/SKILL.mdAgent Skills skill pointing to docs
.agents/skills/hyperterse-agents/SKILL.mdAgent Skills skill for creating agents with Hyperterse
Does not overwrite existing files.

​
hyperterse upgrade

Upgrade the installed binary. 
hyperterse upgrade [flags]

​
Flags

​
--prerelease
boolean
default:"false"
Include pre-release versions in the upgrade check.
​
--major
string
Target a specific major version number, or next for the latest major.

​
Examples

hyperterse upgrade
hyperterse upgrade --prerelease
hyperterse upgrade --major next
hyperterse upgrade --major 3

​
hyperterse completion

Generate shell completion scripts. Hidden from default help. 
hyperterse completion [bash|zsh|fish|powershell]