Skip to main content

Command-Line Help for para

This document contains the help content for the para command-line program.

Command Overview:

para​

Usage: para [OPTIONS] <COMMAND>

Subcommands:​
  • init — Initialize a new project in the current directory
  • connect — Connect with a REPL to a paranet broker. Experimental
  • extension — Commands for managing the Visual Studio Code extension
  • devkit — Management of DevKit
  • docker — Deployment and management of docker backed nodes and packages
  • platform — Commands for managing the platform
  • config — Commands for inspecting node or package configuration
  • context — Commands for interacting with stored node context
  • update — Subcommand for updating packages, the para CLi itself or other aspects of the system
  • completion — Generate shell completions
Options:​

  • -y, --yes — Default to the first selection whenever a selection is offered

    Default value: false

  • -C, --chgdir <CHGDIR> — Change the directory used for deployment. Defaults to current directory

  • --no-auth — Skip auth check on startup

para init​

Initialize a new project in the current directory

Usage: para init [OPTIONS]

Options:​

  • --template <TEMPLATE> — Template to use for initialization. Will default to an empty package if not specified

  • --repo <REPO> — Set the repo to use to fetch the template from

    Default value: s3://otonoma-examples

  • --auth-session <AUTH_SESSION> — Cognito login to use

    Default value: otonoma-devkit

  • --branch <BRANCH> — The git branch of the template repo

  • --name <NAME> — Set the package name. Will prompt if not provided

  • --version <VERSION> — Set the package version. Will prompt if not provided

  • -p, --package-only — If provided, only generate the package scaffold and not the node scaffold

  • --production-node — Set the node config to create a production node. Will prompt for type if not provided

para connect​

Connect with a REPL to a paranet broker. Experimental

Usage: para connect [OPTIONS] <PARANET_HOST>

Arguments:​
  • <PARANET_HOST>
Options:​
  • -p, --password
  • --user <USER>
  • -c, --cognito
  • --actor-id <ACTOR_ID>
  • --cert <CERT>

para extension​

Commands for managing the Visual Studio Code extension

Usage: para extension [OPTIONS] <COMMAND>

Subcommands:​
  • install — Install the extension
  • uninstall — Uninstall the extension
Options:​
  • -a, --app <APP> — The application location to use for installing the extension
  • -q, --quiet — Ignore errors

para extension install​

Install the extension

Usage: para extension install

para extension uninstall​

Uninstall the extension

Usage: para extension uninstall

para devkit​

Management of DevKit

Usage: para devkit <COMMAND>

Subcommands:​
  • login — Performs the login
  • logout — Deletes associated profile information for devkit access

para devkit login​

Performs the login

Usage: para devkit login

para devkit logout​

Deletes associated profile information for devkit access

Usage: para devkit logout

para docker​

Deployment and management of docker backed nodes and packages

Usage: para docker [OPTIONS] <COMMAND>

Subcommands:​
  • deploy — Deploy nodes, packages, or any sub component of a package to an existing node
  • federate — Common configuration overrides
  • affiliate — Common configuration overrides
  • down — Stops a package or node
  • publish — Publish the images to the default registry. This can be useful for global sidecars which have been built by the project
  • ls — List the current nodes running on your machine
  • actors — Commands to interact with actors in a running node
  • connect —
  • request —
Options:​
  • -b, --build-dir <BUILD_DIR> — Override the build directory from the default, which is ./build
  • --config <CONFIG> — Override the package or node configuration. Defaults to searching current directory
  • --node <NODE> — Specify the node ID for package deployment. If not specified, para will prompt
  • --no-deps — Skip processing dependencies

para docker deploy​

Deploy nodes, packages, or any sub component of a package to an existing node

Usage: para docker deploy [OPTIONS] [COMMAND]

Subcommands:​
  • node — Deploy a node, defaults to the node file in the current directory
  • models — Deploy only models from a package. Defaults to the local package
  • actors — Deploy only the actors from a package. Defaults to the local package
  • panels — Deploy only panels from a package. Defaults to the local package
  • sidecars — Deploy only the global sidecars from a package. Defaults to the local package
  • package — Deploy the whole package. This is the default subcommand if none is specified
Options:​
  • -b, --build-dir <BUILD_DIR> — Override the build directory from the default, which is ./build
  • --config <CONFIG> — Override the package or node configuration. Defaults to searching current directory
  • --node <NODE> — Specify the node ID for package deployment. If not specified, para will prompt
  • --no-deps — Skip processing dependencies

para docker deploy node​

Deploy a node, defaults to the node file in the current directory

Usage: para docker deploy node [OPTIONS]

Options:​

  • --pull — Pull new images. Only useful for base images as platform images will always have a new tag

    Default value: false

para docker deploy models​

Deploy only models from a package. Defaults to the local package

Usage: para docker deploy models [OPTIONS]

Options:​
  • --endpoint <ENDPOINT> — Override the proxy endpoint

para docker deploy actors​

Deploy only the actors from a package. Defaults to the local package

Usage: para docker deploy actors [OPTIONS]

Options:​

  • --pull — Pull new docker images

  • --registry <REGISTRY> — Override the registry from the node file

  • --endpoint <ENDPOINT> — Override the proxy endpoint

  • --debugger — Enable the debugger

    Default value: false

para docker deploy panels​

Deploy only panels from a package. Defaults to the local package

Usage: para docker deploy panels [OPTIONS]

Options:​
  • --endpoint <ENDPOINT> — Override the proxy endpoint

para docker deploy sidecars​

Deploy only the global sidecars from a package. Defaults to the local package

Usage: para docker deploy sidecars [OPTIONS]

Options:​
  • --endpoint <ENDPOINT> — Override the proxy endpoint

para docker deploy package​

Deploy the whole package. This is the default subcommand if none is specified

Usage: para docker deploy package [OPTIONS]

Options:​

  • --pull — Pull new docker images

  • --registry <REGISTRY> — Override the registry from the node file

  • --endpoint <ENDPOINT> — Override the proxy endpoint

  • --debugger — Enable the debugger

    Default value: false

para docker federate​

Common configuration overrides

Usage: para docker federate [OPTIONS]

Options:​
  • -b, --build-dir <BUILD_DIR> — Override the build directory from the default, which is ./build
  • --config <CONFIG> — Override the package or node configuration. Defaults to searching current directory
  • --node <NODE> — Specify the node ID for package deployment. If not specified, para will prompt
  • --no-deps — Skip processing dependencies
  • --to <TO> — The local node to federate to. If not specified, you must specify to-address
  • --from <FROM> — Which node to federate from. If this isn't specified, para will try and determine it from the local context
  • --to-address <TO_ADDRESS> — Override the address of the "to" node

para docker affiliate​

Common configuration overrides

Usage: para docker affiliate [OPTIONS]

Options:​
  • -b, --build-dir <BUILD_DIR> — Override the build directory from the default, which is ./build
  • --config <CONFIG> — Override the package or node configuration. Defaults to searching current directory
  • --node <NODE> — Specify the node ID for package deployment. If not specified, para will prompt
  • --no-deps — Skip processing dependencies
  • --to <TO> — The local node to federate to. If not specified, you must specify to-address
  • --from <FROM> — Which node to federate from. If this isn't specified, para will try and determine it from the local context
  • --to-address <TO_ADDRESS> — Override the address of the "to" node

para docker down​

Stops a package or node

Usage: para docker down [COMMAND]

Subcommands:​
  • node — Shutdown a node
  • package — Shutdown a package within a node

para docker down node​

Shutdown a node

Usage: para docker down node [OPTIONS] [NODE]

Arguments:​
  • <NODE> — ID of the node to stop. Looks for a package in the local directory if not specified
Options:​
  • --packages-only — Stop all of the packages in the node, but leave the node itself
  • --all

para docker down package​

Shutdown a package within a node

Usage: para docker down package [PACKAGE]

Arguments:​
  • <PACKAGE> — ID of the package to stop. Look for a package in the local directory if not specified

para docker publish​

Publish the images to the default registry. This can be useful for global sidecars which have been built by the project

Usage: para docker publish

para docker ls​

List the current nodes running on your machine

Usage: para docker ls [OPTIONS] [NODE] [PACKAGE]

Arguments:​
  • <NODE> — If specified, list the packages within a node
  • <PACKAGE> — List the actors within a package
Options:​

  • --packages — Show all packages across all nodes

  • --actors — Show all actors across all nodes and packages

  • -f, --format <FORMAT>

    Default value: table

    Possible values: table, json

para docker actors​

Commands to interact with actors in a running node

Usage: para docker actors [OPTIONS] <COMMAND>

Subcommands:​
  • ls — List the actors
  • restart — Restart the actors
  • reload — Reload the actors
  • shutdown — Shutdown the actors
  • debug — Open the debug client in the default browser if an actor is selected, or print all of the URLs
Options:​
  • --actor <ACTOR> — The specific actor to interact with for the command. Defaults to all

para docker actors ls​

List the actors

Usage: para docker actors ls

para docker actors restart​

Restart the actors

Usage: para docker actors restart

para docker actors reload​

Reload the actors

Usage: para docker actors reload

para docker actors shutdown​

Shutdown the actors

Usage: para docker actors shutdown

para docker actors debug​

Open the debug client in the default browser if an actor is selected, or print all of the URLs

Usage: para docker actors debug

para docker connect​

Usage: para docker connect [OPTIONS]

Options:​
  • -u, --user <USER>
  • --actor-id <ACTOR_ID>

para docker request​

Usage: para docker request --user <USER> <REQUEST>

Arguments:​
  • <REQUEST>
Options:​
  • -u, --user <USER>

para platform​

Commands for managing the platform

Usage: para platform <COMMAND>

Subcommands:​
  • status — Shows the channel as well as latest platform versions for each channel
  • versions — Shows the platform images for the current channel
  • update — Updates the platform images for the current channel
  • switch — Switch the current channel or platform version without updating
  • auth — Show the current auth level

para platform status​

Shows the channel as well as latest platform versions for each channel

Usage: para platform status

para platform versions​

Shows the platform images for the current channel

Usage: para platform versions [OPTIONS]

Options:​

  • -c, --channel <CHANNEL> — Override the current channel

    Possible values: prod, preprod, dev

  • -v, --version <VERSION> — Override the current version

para platform update​

Updates the platform images for the current channel

Usage: para platform update [OPTIONS]

Options:​

  • -c, --channel <CHANNEL> — Set the current channel before updating

    Possible values: prod, preprod, dev

  • -v, --version <VERSION> — Download a specific platform version

para platform switch​

Switch the current channel or platform version without updating

Usage: para platform switch --channel <CHANNEL>

Options:​

  • -c, --channel <CHANNEL> — Set the channel

    Possible values: prod, preprod, dev

para platform auth​

Show the current auth level

Usage: para platform auth

para config​

Commands for inspecting node or package configuration

Usage: para config [OPTIONS] [KIND] <COMMAND>

Subcommands:​
  • show — Prints the config definition
  • location — Prints the location of the config
  • images — Display the images used by the node or package
Arguments:​

  • <KIND>

    Possible values:

    • node: Show the node configuration
    • package: Show the package configuration
Options:​
  • -b, --build-dir <BUILD_DIR> — Override the build directory from the default, which is ./build
  • --config <CONFIG> — Override the package or node configuration. Defaults to searching current directory
  • --node <NODE> — Specify the node ID for package deployment. If not specified, para will prompt
  • --no-deps — Skip processing dependencies

para config show​

Prints the config definition

Usage: para config show

para config location​

Prints the location of the config

Usage: para config location

para config images​

Display the images used by the node or package

Usage: para config images

para context​

Commands for interacting with stored node context

Usage: para context <COMMAND>

Subcommands:​
  • show — Show the context
  • sync — Synchronize local context with existing nodes

para context show​

Show the context

Usage: para context show

para context sync​

Synchronize local context with existing nodes

Usage: para context sync <BACKEND>

Arguments:​

  • <BACKEND>

    Possible values: docker, kube

para update​

Subcommand for updating packages, the para CLi itself or other aspects of the system

Usage: para update <COMMAND>

Subcommands:​
  • self — Updates the para CLI itself to a new version

para update self​

Updates the para CLI itself to a new version

Usage: para update self [OPTIONS] [VERSION]

Arguments:​
  • <VERSION> — Specifies the version to fetch and set. If not provided, the latest will be fetched instead
  • <ENDPOINT>
Options:​
  • --force — Force a redownload even if the file already exists

para completion​

Generate shell completions

Usage: para completion <SHELL>

Arguments:​

  • <SHELL>

    Possible values: bash, elvish, fish, powershell, zsh