CLI Reference

SeaMist installs a command line tool called seamist alongside the API server. Most of the operations of the CLI tool are designed to work locally on the same system where SeaMist is hosted.

Local Functionality

seamist validate <path>

Validate a specified .smx file.

seamist new apikey

Create an API key to control access to the SeaMist service.

This operation works directly on the api-keys.toml file, which probably requires sudo on Linux systems.

seamist new apikey <name> 
    --sites [* | site1[,site2[,site3[,etc]]]]
    [--scopes [scope[,scope[,scope]]]]
    [--expires-in <duration>]

Available scopes are:

• content:read
• fragments:read
• routes:read
• media:read
• data:read
• search:read
• metadata:read
• metadata:write

Default scopes are content:read, fragments:read, routes:read, media:read, data:read, search:read

Default expiry is 1y (1 year)

Remote-capable Functionality

seamist status

Prints status information about the installation. If you have configured the CLI tool with an API key, it will show cache status information as well.