specter

command module
v0.5.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 24, 2026 License: MIT Imports: 25 Imported by: 0

README

specter

Ask DeepWiki CI Go Report Card Go Version Latest Release

Lightweight mock API server. Define endpoints in YAML, run instantly.

  • Hot reload — edit config.yml and changes apply immediately
  • Response templates, faker, stateful mocking, rate limiting
  • Single binary, no dependencies

Install

Docker

docker run -v $(pwd)/config.yml:/config.yml ghcr.io/saku0512/specter -c /config.yml

Homebrew (macOS / Linux)

brew tap Saku0512/specter https://github.com/Saku0512/specter
brew install specter

curl (macOS / Linux)

curl -fsSL https://raw.githubusercontent.com/Saku0512/specter/main/install.sh | bash

PowerShell (Windows)

irm https://raw.githubusercontent.com/Saku0512/specter/main/install.ps1 | iex

Quick start

specter init          # generate config.yml
specter -c config.yml # start the server
routes:
  - path: /users
    method: GET
    response:
      - id: 1
        name: Alice

Documentation

See config.example.yml for a full working example.

License

MIT

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
cmd
export
Package export provides the `specter export` subcommand, which reads the request history of a running specter instance and generates a starter config.yml from the observed (method, path) pairs.
Package export provides the `specter export` subcommand, which reads the request history of a running specter instance and generates a starter config.yml from the observed (method, path) pairs.
gen

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL