Usage

On Windows, Spike is started and stopped using the "Start Spike" and "Stop Spike" menu items in the Start Menu. This will also create a project directory named "spike" in your home directory (c:\Users\<USERNAME>), and it will enable/disable the system-wide proxy settings. Select "Start Spike" under Start Menu > Spike, and then go to http://localhost:9600 to see Spike UI running.

Command line options

Spike has no external dependencies, so it can also be easily started from the command line.

% spike.osx -h
Usage: spike.osx [options]

  -auto-discover
        Automatically create new services for proxied URLs.
  -config-file string
        Config file (TOML)
  -d string
        Project directory.
  -e string
        Environment to use ('dev', 'prod', etc).
  -env-file string
        Name of environments file. (default "spike-environments.json")
  -header-prefix string
        Prefix to add to all Spike-generated http headers.
  -include-urls string
        List of URL prefixes to include in service auto-discovery.  Comma-separated.
  -log-format string
        'text', 'json', or 'logstash'. (default "text")
  -log-rejected-urls
        When include-urls is set, this flag logs all rejected URLs.
  -proxy-port int
        Proxy HTTP port. (default 9700)
  -read-only
        Run in read-only mode.
  -s string
        Name of services file. (default "spike-services.json")
  -web-port int
        Web HTTP port. (default 9600)

App settings, captures response payloads, statistics, and other auxilliary files will be stored in the -d configuration directory. No files are created outside the configuration directory.