Commands

All available CLI commands and their options.

akuma init [name]

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

shell

akuma init my-api
akuma init          # interactive prompts

Option	Description	Default
`name`	Server name	my-api

akuma start

Start the mock server locally. Reads akuma.yml, creates database tables for typed schemas, seeds data, and starts serving. The address is a run-time choice (flags), never part of the config. Pass one or more config files to run them side by side, each on the next port up from --port.

shell

akuma start
akuma start --port 8080
akuma start api.yml admin.yml   # run several configs on sequential ports
akuma start --verbose

Option	Description	Default
`--port, -p`	Port to listen on (extra files get the next ports up)	3000
`--host, -H`	Host/interface to bind to	127.0.0.1
`--verbose, -v`	Enable debug logging	false

akuma add

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

shell

akuma add

akuma import <file>

Scaffold endpoints from an OpenAPI or Swagger specification. Akuma reads the spec's paths and creates a matching path and method for each operation, each with a placeholder inline: response for you to fill in. It does not import schemas or response bodies, so treat it as a starting skeleton, not a full translation.

shell

akuma import openapi.json
akuma import swagger.yaml

akuma list

List all configured endpoints from akuma.yml.

shell

akuma list

akuma info

Show the local config's name, schemas, and endpoints.

shell

akuma info

Cloud commands

Create and run hosted servers in your Akuma Cloud account. Sign in once, then deploy your akuma.yml.

akuma login

shell

akuma login
akuma login --token akuma_xxx

akuma whoami

Show the signed-in cloud account and the token's scopes.

shell

akuma whoami

akuma deploy

Upload your local akuma.yml to the cloud and deploy one environment of it. Re-running reloads the config in place. The hosted server picks its own address (you do not set a port).

shell

akuma deploy
akuma deploy --env prd
akuma deploy --name my-api --env prd

Option	Description	Default
`--env`	Environment to deploy (a key under `environments:`)	default
`--name`	Server name (the project identity)	config's `name`

akuma servers

List the hosted servers in your account, with their status and URL.

shell

akuma servers

akuma logout

Remove the stored cloud credentials.

shell

akuma logout

Global options

Option	Description	Default
`--config, -c`	Path to the config file	akuma.yml
`--api`	Cloud API base URL	https://heyakuma.com

Aliases

Command	Alias
`init`	`i`
`start`	`s`
`add`	`a`
`import`	`imp`
`list`	`ls`