Skip to main content
Version: 0.7.0 (alpha)

Seaplane CLI

Seaplane provides users the following commands to seamlessly get started:

Command NameDescription
initCreate a new Seaplane project that has a default project file structure. Click here for more information on creating a new project and the default file structure.
buildBuild the Seaplane project, which creates the project zip file and build folder.
deployBuild the Seaplane project and deploy your project on Seaplane's infrastructure.
destroyDestroy the running tasks of your application. Please note that changing your tasks' names in between a seaplane deploy and seaplane destroy will orphan the renamed tasks. The destroy command only destroys the tasks by their task name in your project.
statusShows the dataflow of a deployed application including the number of messages in and out per task. Learn more by going to Application Status. Please note that message counts do not reset when apps are redeployed.
status -wAutomatically refreshes to show the status every 2 seconds. Please note that you must have watch installed on your machine or virtual environment to use this command. For macOS download Homebrew from their website and run brew install watch to complete the installation of watch.
requestSend data to the application entry point. Returns a request ID, which can be used to identify that specific request and retrieve the output.
responseBy default seaplane response gets the last request's data from the response endpoint. Alternatively, you can get a specific request's response by including its ID as seaplane response -r <request-id> or seaplane response --request_id <request-id>
--versionReturns the installed Seaplane version on your machine or in your virtual environment.
--helpReturns all available Seaplane commands.

seaplane initโ€‹

Run seaplane init <my-seaplane-project> command. This will create a new Seaplane project with a default project file structure. For more information on the default project file structure click here.

seaplane init <my-seaplane-project>

seaplane buildโ€‹

Inside your Seaplane project root directory use the command seaplane build to build the application. This creates the build folder, schema.json, and project zip that are used by the Seaplane platform to deploy your app. Learn more about applications here.


Please note to run poetry lock and poetry install if this is the first time you are building and deploying your application or if you made any changes to your pyproject.toml file.

seaplane build

seaplane deployโ€‹

Deploys an application on Seaplane's infrastructure when executed inside a Seaplane project root directory.

seaplane deploy

seaplane destroyโ€‹

Destroys an application and its associated tasks. seaplane destroy deletes all infrastructure associated with this application with the exception of persistent data stores.

This command will destroy tasks by their unique task names that were defined prior to seaplane deploy.

If you run seaplane deploy, change a task name, and run seaplane destroy, then the changed task name is not destroyed. That task is now an orphan. To avoid ongoing tasks change a task's name prior to seaplane deploy to ensure that seaplane destroy removes the application and its associated tasks.


You can use seaplane status to verify that the previous tasks that you had run are now completed.

seaplane destroy

seaplane statusโ€‹

Run seaplane status in your project root directory. seaplane status shows the dataflow of a deployed application including the number of messages in and out per task.

Learn more about your application status and how to debug with the application status here. Please note that message counts do not reset when apps are redeployed.

seaplane status

seaplane status -wโ€‹

Run the seaplane status -w command in your project root directory to automatically refresh the status every 2 seconds.


To use seaplane status -w you need to have watch installed on your machine or on your virtual environment. For macOS follow the steps below to install Homebrew and watch:

  1. Download Homebrew from their website.
  2. Run brew install watch.
seaplane status -w

seaplane requestโ€‹

Use seaplane request to send data to your application entry point. Please note that the input data should match the expected data type of your application. For example, if your application expects a JSON string your input should match this format.

seaplane request returns its request-id.

seaplane request -d'{"foo": "bar"}'

seaplane responseโ€‹

Use seaplane response to get data from your application endpoint. By default the command seaplane response uses the last request and returns the associated data. To get the data from a specific request use seaplane response --request_id <request-id>

  1. By default takes the last request and returns the response.
seaplane response
  1. Use a request-ID to get a specific response.
seaplane response -r <request-id>


seaplane response --request_id <request-id>

seaplane --versionโ€‹

seaplane --version or seaplane -v returns the installed version of Seaplane on your machine or in your virutal environment.

seaplane --version


seaplane -v

seaplane --helpโ€‹

Run seaplane --help, seaplane -h, or seaplane to see the list of available commands in your terminal.

seaplane --help


seaplane -h