Commands

All available CLI commands and their options.

akuma init [name]

Create a new mock server. Generates a akuma.yml config file with example endpoints.

akuma init my-api
akuma init --port 8080
akuma init          # interactive prompts
OptionDescriptionDefault
nameServer namemy-api
--port, -pPort number3000

akuma start

Start the mock server. Reads akuma.yml, creates database tables for typed schemas, seeds data, and starts serving.

akuma start
akuma start --port 8080
akuma start --host 127.0.0.1
akuma start --verbose
OptionDescriptionDefault
--port, -pPort (overrides config)3000
--host, -HHost to bind to0.0.0.0
--verbose, -vEnable debug loggingfalse

akuma add

Add a new endpoint interactively. Prompts for HTTP method, path, and description, then appends to akuma.yml.

akuma add

akuma import <file>

Import endpoints from an OpenAPI or Swagger specification file.

akuma import openapi.json
akuma import swagger.yaml

akuma list

List all configured endpoints from akuma.yml.

akuma list

akuma info

Show server configuration and status information.

akuma info

Aliases

CommandAlias
initi
starts
adda
importimp
listls