Seaplane CLI

Seaplane provides users the following commands to seamlessly get started:

Command Name	Description
init	Create 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.
build	Build the Seaplane project, which creates the project zip file and build folder.
deploy	Build the Seaplane project and deploy your project on Seaplane's infrastructure.
destroy	Destroy 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.
status	Shows 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 -w	Automatically 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.
request	Send data to the application entry point. Returns a request ID, which can be used to identify that specific request and retrieve the output.
response	By 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>
--version	Returns the installed Seaplane version on your machine or in your virtual environment.
--help	Returns 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.

Command Line

seaplane init <my-seaplane-project>

Expected Output

🛩️  <my-seaplane-project> project generated successfully!

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.

note

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.

Command Line

seaplane build

Expected Output

[Seaplane]

	Seaplane Apps <version_number>

[Seaplane] ⌛️ Assign Task process-data to App: <app_name>-processor-application
{"apps": {"<app_name>-processor-application": {"id": "<app_name>-processor-application", "entry_point": {"type": "API", "parameters": []}, "tasks": [{"id": "process-data", "name": "process_data", "replicas": 1, "ack_wait": 2}], "io": {"entry_point": ["process-data"], "returns": "process-data"}}}, "carrier_endpoint": "https://carrier.cplane.cloud/v1", "identity_endpoint": "https://flightdeck.cplane.cloud/v1"}

seaplane deploy

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

Command Line

seaplane deploy

Expected Output

[Seaplane] 🚀 Deployment complete

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.

tip

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

Command Line

seaplane destroy

Expected Output

seaplane destroy

[Seaplane]

	Seaplane Apps <version number>

[Seaplane] ⌛️ Assign Task <my-project-task> to App: <my-project-app>
[Seaplane] Requesting access token...

seaplane status

[Seaplane]

	Seaplane Apps <version number>

[Seaplane] Requesting access token...


╒════════════════════╤══════════════════════════╤═══════════════╤════════════════╕
│ Task Name          │ Status                   │   Messages In │   Messages Out │
╞════════════════════╪══════════════════════════╪═══════════════╪════════════════╡
│ <my-project-task>  │ <number> completed tasks │             0 │              0 │
╘════════════════════╧══════════════════════════╧═══════════════╧════════════════╛
NOTE: Message counts are currently unavailable for HTTP ENDPOINTS.

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.

Command Line

seaplane status

Expected Output

seaplane status
[Seaplane]

	Seaplane Apps <version number>

[Seaplane] Requesting access token...


╒═══════════════════╤═══════════════════╤═══════════════╤════════════════╕
│ Task Name         │ Status            │   Messages In │   Messages Out │
╞═══════════════════╪═══════════════════╪═══════════════╪════════════════╡
│ <my-project-task> │ 1: running        │             0 │              0 │
│                   │ 2 completed tasks │               │                │
╘═══════════════════╧═══════════════════╧═══════════════╧════════════════╛
NOTE: Message counts are currently unavailable for HTTP ENDPOINTS.

seaplane status -w

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

note

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.

Command Line

seaplane status -w

Expected Output

[Seaplane]
Seaplane Apps version 0.5b12
[Seaplane] Requesting access token...
╒════════════════╤════════════════════╤═══════════════╤════════════════╕
│ Task Name      │ Status             │   Messages In │   Messages Out │
╞════════════════╪════════════════════╪═══════════════╪════════════════╡
│ a              │ 1: running         │            11 │              0 │
│                │ 3 completed tasks  │               │                │
├────────────────┼────────────────────┼───────────────┼────────────────┤
│ b              │ 1: running         │             0 │              0 │
│                │ 3 completed tasks  │               │                │
├────────────────┼────────────────────┼───────────────┼────────────────┤
│ c              │ 1: running         │             0 │              0 │
│                │ 2: running         │               │                │
│                │ 3: running         │               │                │
│                │ 4: running         │               │                │
│                │ 5: running         │               │                │
│                │ 15 completed tasks │               │                │
╘════════════════╧════════════════════╧═══════════════╧════════════════╛
NOTE: Message counts are currently unavailable for HTTP ENDPOINTS.

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.

Command Line

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

Expected Output

request_id: <a-unique-id>

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>

Command Line

1. By default takes the last request and returns the response.

seaplane response

2. Use a request-ID to get a specific response.

seaplane response -r <request-id>

OR

seaplane response --request_id <request-id>

Expected Output

Please note that the example is with the default Hello-World Project.

1. For seaplane response

Hello World <last-request-data>

2. For seaplane response --request_id <request-id>

Hello World <request-id-data>

seaplane --version

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

Command Line

seaplane --version

OR

seaplane -v

Expected Output

seaplane <version-number>

seaplane --help

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

Command Line

seaplane --help

OR

seaplane -h

OR

seaplane

Expected Output

usage: seaplane [-h] [-v] {build,deploy,destroy,init,status,request,response} ...

Seaplane Apps command line interface

positional arguments:
  {build,deploy,destroy,init,status,request,response}
                        Available commands
    build               Build command
    deploy              Deploy command
    destroy             Remove your App and associated tasks
    init                Init command
    status              Status of your app and resources
    request             Send data to the request endpoint
    response            Get data from the response endpoint

options:
  -h, --help            show this help message and exit
  -v, --version         show program's version number and exit