Skip to main content

​
hitspec docs

Output AI-readable documentation (llms.txt) for AI agents to learn hitspec syntax. 
hitspec docs
This prints the complete hitspec specification in a format optimized for LLM consumption. Useful for integrating hitspec with AI coding assistants.

​
hitspec serve

Start a browser-based API Client Manager for working with hitspec files. 
hitspec serve [file|directory] [flags]

​
What It Provides

  • Web-based UI for editing and running API tests
  • REST API for programmatic access
  • Real-time file watching with WebSocket updates
  • Stress testing dashboard
  • Mock server management

​
Flags

FlagShortDescriptionDefault
--port-pPort to run the server on4000
--hostBind addresslocalhost
--openAuto-open browsertrue
--watch-wWatch for file changestrue
--corsEnable CORS headersfalse
--api-onlyREST API only, no web UIfalse
--read-onlyDisallow file mutationsfalse
--env-eDefault environmentdev
--configPath to hitspec.yaml
--verbose-vVerbose loggingfalse
--allow-shellAllow shell command executionfalse
--allow-dbAllow database assertionsfalse

​
Examples

# Start with defaults (opens browser at localhost:4000)
hitspec serve

# Serve a specific directory
hitspec serve ./tests/

# Custom port, no auto-open
hitspec serve --port 8080 --open=false

# API-only mode for headless/CI usage
hitspec serve --api-only --cors

# Read-only mode for shared environments
hitspec serve --read-only --cors --host 0.0.0.0