❤
npm
Sign UpSign In

This package has been deprecated

Author message:

Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

@steamship/cli
TypeScript icon, indicating that this package has built-in type declarations

2.2.12 • Public • Published

steamship-cli

A command line tool for Steamship, the fastest way to add Language AI to your software.

oclif Version Downloads/week License

Quick setup:

npm install -g @steamship/cli
ship login
ship create

Then follow the instructions in the resulting README.md file of your starter project.

Usage

$ npm install -g @steamship/cli
$ ship COMMAND
running command...
$ ship (--version|-v)
@steamship/cli/2.2.12 linux-x64 node-v14.21.2
$ ship --help [COMMAND]
USAGE
  $ ship COMMAND
...

Commands

ship create [HANDLE]

Creates a new Steamship Package or Plugin

USAGE
  $ ship create [HANDLE]

ARGUMENTS
  HANDLE  The new project handle.

DESCRIPTION
  Creates a new Steamship Package or Plugin

EXAMPLES
  $ ship create project-handle

See code: dist/commands/create.ts

ship deploy

Deploys a Steamship Package or Plugin from a project's root folder.

USAGE
  $ ship deploy [-h]

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Deploys a Steamship Package or Plugin from a project's root folder.

EXAMPLES
  $ ship deploy

See code: dist/commands/deploy.ts

ship help [COMMANDS]

Display help for ship.

USAGE
  $ ship help [COMMANDS] [-n]

ARGUMENTS
  COMMANDS  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for ship.

See code: @oclif/plugin-help

ship login

Logs in to Steamship

USAGE
  $ ship login [-a <value>] [-s <value>] [-t <value>]

FLAGS
  -a, --api_domain=<value>   The API domain to login to. Default is https://api.steamship.com/api/v1/
  -s, --site_domain=<value>  The site domain to login to. Default is https://api.steamship.com/api/v1/
  -t, --token=<value>        A previously generated API token to authenticate against.

DESCRIPTION
  Logs in to Steamship

EXAMPLES
  $ ship login

  $ ship login -t 1234-5678-9101-1121

  $ ship login -s https://api.steamship.com/api/v1/ -a https://api.steamship.com

See code: dist/commands/login.ts

ship package:deploy

Deploys a Steamship Package

USAGE
  $ ship package:deploy [--help] [--version]

FLAGS
  --help     Show CLI help.
  --version  Show CLI version.

DESCRIPTION
  Deploys a Steamship Package

EXAMPLES
  $ ship package:deploy

  $ ship package:deploy --version <versionHandle>

See code: dist/commands/package/deploy.ts

ship package:instance:create

Creates an instance of a package.

USAGE
  $ ship package:instance:create [-h <value>] [-p <value>] [-v <value>]

FLAGS
  -h, --handle=<value>   Handle for the instance.
  -p, --package=<value>  Package handle.
  -v, --version=<value>  Package Version handle.

DESCRIPTION
  Creates an instance of a package.

EXAMPLES
  $ ship package:instance:create

See code: dist/commands/package/instance/create.ts

ship package:instance:delete

Delete an app.

USAGE
  $ ship package:instance:delete [-a <value>] [-i <value>]

FLAGS
  -a, --package=<value>   the Package handle
  -i, --instance=<value>  the Package Instance handle

DESCRIPTION
  Delete an app.

EXAMPLES
  $ ship package:instance:delete --instance <instanceHandle>

  $ ship package:instance:delete --package <packageHandle> --instance <instanceHandle>

See code: dist/commands/package/instance/delete.ts

ship package:instance:invoke

Invokes a method on an package instance.

USAGE
  $ ship package:instance:invoke [-p <value>] [-i <value>] [-m <value>] [-v <value>] [-c]

FLAGS
  -c, --curl              Display cURL command to invoke instead of calling.
  -i, --instance=<value>  The Instance Handle
  -m, --method=<value>    [default: /] The method to run
  -p, --package=<value>   The Package Handle
  -v, --verb=<value>      [default: POST] HTTP Verb. Either GET or POST. Defaults to POST.

DESCRIPTION
  Invokes a method on an package instance.

EXAMPLES
  $ ship package:instance:invoke --package hello-world --instance default --method greet --name "Ted"

See code: dist/commands/package/instance/invoke.ts

ship package:instance:list

Lists the instances of an Package Version.

USAGE
  $ ship package:instance:list [-p <value>]

FLAGS
  -p, --package=<value>  the Package handle

DESCRIPTION
  Lists the instances of an Package Version.

EXAMPLES
  $ ship package:instance:list

  $ ship package:instance:list --package <packageHandle>

See code: dist/commands/package/instance/list.ts

ship package:list

Lists your apps.

USAGE
  $ ship package:list

DESCRIPTION
  Lists your apps.

EXAMPLES
  $ ship package:list

See code: dist/commands/package/list.ts

ship package:update

Updates a Steamship Package in the registry

USAGE
  $ ship package:update [--help] [--version]

FLAGS
  --help     Show CLI help.
  --version  Show CLI version.

DESCRIPTION
  Updates a Steamship Package in the registry

EXAMPLES
  $ ship package:update

See code: dist/commands/package/update.ts

ship package:version:list

Lists the versions of an Package.

USAGE
  $ ship package:version:list [-a <value>]

FLAGS
  -a, --package=<value>  the Package handle

DESCRIPTION
  Lists the versions of an Package.

EXAMPLES
  $ ship package:version:list

  $ ship package:version:list --package <packageHandle>

See code: dist/commands/package/version/list.ts

ship plugin:deploy

Deploys a Steamship Plugin

USAGE
  $ ship plugin:deploy [--help] [--version]

FLAGS
  --help     Show CLI help.
  --version  Show CLI version.

DESCRIPTION
  Deploys a Steamship Plugin

EXAMPLES
  $ ship plugin:deploy

  $ ship plugin:deploy --version <versionHandle>

See code: dist/commands/plugin/deploy.ts

ship plugin:instance:create

Creates an instance of the Plugin.

USAGE
  $ ship plugin:instance:create [-h <value>] [-p <value>] [-v <value>]

FLAGS
  -h, --handle=<value>   Handle for the instance.
  -p, --plugin=<value>   Plugin handle.
  -v, --version=<value>  Plugin Version handle.

DESCRIPTION
  Creates an instance of the Plugin.

EXAMPLES
  $ ship plugin:instance:create

See code: dist/commands/plugin/instance/create.ts

ship plugin:instance:delete

Delete a plugin Instance.

USAGE
  $ ship plugin:instance:delete [-p <value>] [-i <value>] [-s <value>]

FLAGS
  -i, --instance=<value>  the Plugin Instance handle
  -p, --plugin=<value>    the Plugin handle
  -s, --space=<value>     the Workspace handle

DESCRIPTION
  Delete a plugin Instance.

EXAMPLES
  $ ship plugin:instance:delete

  $ ship plugin:instance:delete --instance <instanceHandle>

  $ ship plugin:instance:delete --plugin <packageHandle> --instance <instanceHandle>

See code: dist/commands/plugin/instance/delete.ts

ship plugin:instance:list

Lists the instances of an Plugin Version.

USAGE
  $ ship plugin:instance:list [-a <value>]

FLAGS
  -a, --plugin=<value>  the Plugin handle

DESCRIPTION
  Lists the instances of an Plugin Version.

EXAMPLES
  $ ship plugin:instance:list

  $ ship plugin:instance:list --plugin <pluginHandle>

See code: dist/commands/plugin/instance/list.ts

ship plugin:list

Lists your plugins.

USAGE
  $ ship plugin:list [-m]

FLAGS
  -m, --mine  List your own plugins.

DESCRIPTION
  Lists your plugins.

EXAMPLES
  $ ship plugin:list

  $ ship plugin:list --mine

See code: dist/commands/plugin/list.ts

ship plugin:update

Updates a Steamship Plugin in the registry

USAGE
  $ ship plugin:update [--help] [--version]

FLAGS
  --help     Show CLI help.
  --version  Show CLI version.

DESCRIPTION
  Updates a Steamship Plugin in the registry

EXAMPLES
  $ ship plugin:update

See code: dist/commands/plugin/update.ts

ship plugin:version:list

Lists the versions of an Plugin.

USAGE
  $ ship plugin:version:list [-p <value>]

FLAGS
  -p, --plugin=<value>  the plugin handle

DESCRIPTION
  Lists the versions of an Plugin.

EXAMPLES
  $ ship plugin:version:list

See code: dist/commands/plugin/version/list.ts

ship project:bundle

Bundles a deployment package (for testing)

USAGE
  $ ship project:bundle [--help]

FLAGS
  --help  Show CLI help.

DESCRIPTION
  Bundles a deployment package (for testing)

EXAMPLES
  $ ship util:bundle

See code: dist/commands/project/bundle.ts

ship project:get [PROPERTY]

Returns a property from your steamship.json file

USAGE
  $ ship project:get [PROPERTY]

ARGUMENTS
  PROPERTY  Property in steamship.json to fetch. Dot-notation will traverse nested objects.

DESCRIPTION
  Returns a property from your steamship.json file

EXAMPLES
  $ ship project:get name

  $ ship project:get plugin.type

See code: dist/commands/project/get.ts

ship project:sync-docs

Syncs standardized documentation and settings. Will not overwrite without asking.

USAGE
  $ ship project:sync-docs [--help] [-s] [-a <value>]

FLAGS
  -a, --all=<value>  skip|overwrite|propose - auto-apply to conflicts
  -s, --simulate     only simulate the sync
  --help             Show CLI help.

DESCRIPTION
  Syncs standardized documentation and settings. Will not overwrite without asking.

EXAMPLES
  $ ship util:sync-docs

  $ ship util:sync-docs --simulate

  $ ship util:sync-docs --all=skip|overwrite|propose

See code: dist/commands/project/sync-docs.ts

ship run INSTANCE

Runs a Steamship app

USAGE
  $ ship run [INSTANCE] [-h] [-i <value>]

ARGUMENTS
  INSTANCE  The package Instance.

FLAGS
  -h, --help           Show CLI help.
  -i, --input=<value>  Input file to use as data input for an app

DESCRIPTION
  Runs a Steamship app

EXAMPLES
  $ ship run --input input1.json
  { result: 'Hello, Steamship' }

  $ ship run --data "{\"name\": \"Steamship\"}"
  { result: 'Hello, Steamship' }

See code: dist/commands/run.ts

ship task:info

Lists tasks in the Steamship.

USAGE
  $ ship task:info -i <value>

FLAGS
  -i, --id=<value>  (required) Task ID

DESCRIPTION
  Lists tasks in the Steamship.

EXAMPLES
  $ ship plugin:task:get --id <taskUuid>

See code: dist/commands/task/info.ts

ship task:list

Lists tasks in the Steamship.

USAGE
  $ ship task:list [-t <value>] [-s <value>] [-i <value>]

FLAGS
  -i, --id=<value>     the Task ID
  -s, --space=<value>  the Workspace handle
  -t, --state=<value>  Task Status. succeeded|failed|waiting|running.

DESCRIPTION
  Lists tasks in the Steamship.

EXAMPLES
  $ ship plugin:task:list

  $ ship plugin:task:list --state <succeeded|failed|waiting|running>

  $ ship plugin:task:list --space <spaceHandle>

  $ ship plugin:task:list --id <taskUuid>

See code: dist/commands/task/list.ts

ship try [HANDLE]

Downloads a Jupyter demo of a Steamship Package or Plugin.

USAGE
  $ ship try [HANDLE]

ARGUMENTS
  HANDLE  The package or plugin handle.

DESCRIPTION
  Downloads a Jupyter demo of a Steamship Package or Plugin.

EXAMPLES
  $ ship try <app-or-plugin-name>

See code: dist/commands/try.ts

ship update

Updates a Steamship Package or Plugin from a project's root folder.

USAGE
  $ ship update [-h]

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Updates a Steamship Package or Plugin from a project's root folder.

EXAMPLES
  $ ship update

See code: dist/commands/update.ts

ship user:handle:set [HANDLE]

Sets your user handle.

USAGE
  $ ship user:handle:set [HANDLE]

DESCRIPTION
  Sets your user handle.

EXAMPLES
  $ ship user:handle:set <new-handle>

See code: dist/commands/user/handle/set.ts

ship user:info

Displays information about the current Steamship CLI and authentication

USAGE
  $ ship user:info

DESCRIPTION
  Displays information about the current Steamship CLI and authentication

EXAMPLES
  $ ship user:info

See code: dist/commands/user/info.ts

ship version

USAGE
  $ ship version [--json] [--verbose]

FLAGS
  --verbose  Show additional information about the CLI.

GLOBAL FLAGS
  --json  Format output as json.

FLAG DESCRIPTIONS
  --verbose  Show additional information about the CLI.

    Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI is using.

See code: @oclif/plugin-version

ship workspace:delete

Delete a Workspace.

USAGE
  $ ship workspace:delete [-h <value>]

FLAGS
  -h, --handle=<value>  the workspace handle

DESCRIPTION
  Delete a Workspace.

EXAMPLES
  $ ship workspace:delete <handle>

See code: dist/commands/workspace/delete.ts

ship workspace:list

Lists your workspaces.

USAGE
  $ ship workspace:list

DESCRIPTION
  Lists your workspaces.

EXAMPLES
  $ ship workspace:list

See code: dist/commands/workspace/list.ts

Readme

Keywords

Package Sidebar

Install

npm i @steamship/cli

Repository

github.com/steamship-core/steamship-cli

Homepage

github.com/nludb/typescript-client

Weekly Downloads

6

Version

2.2.12

License

MIT

Unpacked Size

193 kB

Total Files

154

Last publish

Collaborators

  • steamshipmax
  • eob
Try on RunKit
Report malware