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
  • logs — Get logs from an actor
  • request —
  • create —
  • secret —
  • extension — Commands for managing the Visual Studio Code extension
  • netflow — Commands for interfacing with netflow for a node
  • devkit — Management of DevKit
  • docker — Deployment and management of docker backed nodes and packages
  • catalog —
  • remote — Common configuration overrides
  • federate —
  • code —
  • tree —
  • upload —
  • upload-state —
  • deploy —
  • undeploy —
  • 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

  • --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

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

para connect​

Connect with a REPL to a paranet broker. Experimental

Usage: para connect [OPTIONS] <NODE_ID>

Arguments:​
  • <NODE_ID> — Node ID in nodelist file, or node URL
Options:​
  • -p, --password — Prompt for password
  • --user <USER> — Node local login username
  • -c, --cognito <COGNITO> — Cognito login username
  • --devkit — Login using devkit credentials
  • --insecure — Allow self-signed node server certificate
  • --actor-id <ACTOR_ID>
  • --cert <CERT>
  • --partition

para logs​

Get logs from an actor

Usage: para logs [OPTIONS] <NODE_ID> <ACTOR>

Arguments:​
  • <NODE_ID> — Node ID in nodelist file, or node URL
  • <ACTOR> — Actor name without or without version
Options:​
  • -p, --password — Prompt for password
  • --user <USER> — Node local login username
  • -c, --cognito <COGNITO> — Cognito login username
  • --devkit — Login using devkit credentials
  • --insecure — Allow self-signed node server certificate
  • --actor-id <ACTOR_ID>
  • --cert <CERT>

para request​

Usage: para request [OPTIONS] <NODE_ID> <SKILL> [DATA]

Arguments:​
  • <NODE_ID> — Node ID in nodelist file, or node URL
  • <SKILL>
  • <DATA>
Options:​
  • -p, --password — Prompt for password
  • --user <USER> — Node local login username
  • -c, --cognito <COGNITO> — Cognito login username
  • --devkit — Login using devkit credentials
  • --insecure — Allow self-signed node server certificate
  • --actor-id <ACTOR_ID>
  • --cert <CERT>
  • --partition

para create​

Usage: para create <COMMAND>

Subcommands:​
  • user —
  • cognito-user —

para create user​

Usage: para create user [OPTIONS] <NODE_ID> <USERNAME>

Arguments:​
  • <NODE_ID>
  • <USERNAME>
Options:​
  • --login <LOGIN>
  • --cognito-login <COGNITO_LOGIN>
  • -p, --password
  • --devkit
  • --insecure
  • --display <DISPLAY> — New user's display name (default: username)
  • --role <ROLE>

para create cognito-user​

Usage: para create cognito-user [OPTIONS] <NODE_ID> <USERNAME>

Arguments:​
  • <NODE_ID>
  • <USERNAME>
Options:​
  • --login <LOGIN>
  • --cognito-login <COGNITO_LOGIN>
  • -p, --password
  • --devkit
  • --insecure
  • --display <DISPLAY> — New user's display name (default: username)
  • --role <ROLE>

para secret​

Usage: para secret <COMMAND>

Subcommands:​
  • write —
  • read —
  • add-readers —
  • remove-readers —

para secret write​

Usage: para secret write [OPTIONS] <NODE_ID> <ID>

Arguments:​
  • <NODE_ID> — Node ID in nodelist file, or node URL
  • <ID> — Secret id
Options:​
  • -p, --password — Prompt for password
  • --user <USER> — Node local login username
  • -c, --cognito <COGNITO> — Cognito login username
  • --devkit — Login using devkit credentials
  • --insecure — Allow self-signed node server certificate
  • --actor-id <ACTOR_ID>
  • --cert <CERT>
  • --env-file <ENV_FILE> — Environment file with secret values
  • --file <KEY=PATH> — Secret value from file as key=path (may be specified multiple times)
  • --reader <READER> — Reader (may be specified multiple times)

para secret read​

Usage: para secret read [OPTIONS] <NODE_ID> <ID>

Arguments:​
  • <NODE_ID> — Node ID in nodelist file, or node URL
  • <ID> — Secret id
Options:​
  • -p, --password — Prompt for password
  • --user <USER> — Node local login username
  • -c, --cognito <COGNITO> — Cognito login username
  • --devkit — Login using devkit credentials
  • --insecure — Allow self-signed node server certificate
  • --actor-id <ACTOR_ID>
  • --cert <CERT>

para secret add-readers​

Usage: para secret add-readers [OPTIONS] <NODE_ID> <ID> [READERS]...

Arguments:​
  • <NODE_ID> — Node ID in nodelist file, or node URL
  • <ID> — Secret id
  • <READERS> — Readers to add or remove
Options:​
  • -p, --password — Prompt for password
  • --user <USER> — Node local login username
  • -c, --cognito <COGNITO> — Cognito login username
  • --devkit — Login using devkit credentials
  • --insecure — Allow self-signed node server certificate
  • --actor-id <ACTOR_ID>
  • --cert <CERT>

para secret remove-readers​

Usage: para secret remove-readers [OPTIONS] <NODE_ID> <ID> [READERS]...

Arguments:​
  • <NODE_ID> — Node ID in nodelist file, or node URL
  • <ID> — Secret id
  • <READERS> — Readers to add or remove
Options:​
  • -p, --password — Prompt for password
  • --user <USER> — Node local login username
  • -c, --cognito <COGNITO> — Cognito login username
  • --devkit — Login using devkit credentials
  • --insecure — Allow self-signed node server certificate
  • --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
  • reinstall — Reinstall the extension by first attempting to uninstall an existing one
  • 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 reinstall​

Reinstall the extension by first attempting to uninstall an existing one

Usage: para extension reinstall

para extension uninstall​

Uninstall the extension

Usage: para extension uninstall

para netflow​

Commands for interfacing with netflow for a node

Usage: para netflow <COMMAND>

Subcommands:​
  • goals — Inspect goal trees from netflow
  • logs — View actor logs from netflow

para netflow goals​

Inspect goal trees from netflow

Usage: para netflow goals [OPTIONS]

Options:​
  • -w, --watch — Watch the stream continously
  • --endpoint <ENDPOINT> — Connect directly to an endpoint
  • -n, --node <NODE> — Node ID to use to determine the endpoint, if it isn't provided

para netflow logs​

View actor logs from netflow

Usage: para netflow logs [OPTIONS]

Options:​
  • -f, --follow — Continue following the logs
  • -a, --actor <ACTOR> — Filter to only this actor
  • --log-level <LOG_LEVEL> — Limits the log level, otherwise all logs are displayed
  • --endpoint <ENDPOINT> — Connect directly to an endpoint
  • -n, --node <NODE> — Node ID to use to determine the endpoint, if it isn't provided

para devkit​

Management of DevKit

Usage: para devkit <COMMAND>

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

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 devkit token​

Get devkit access token

Usage: para devkit token

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
  • 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 —
  • list —
  • command —
Options:​
  • --remote <REMOTE> — Remote vm to use
  • -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
  • --package-config <PACKAGE_CONFIG>
  • --node-config <NODE_CONFIG>
  • --set <OVERRIDES> — Set a configuration value
  • --node <NODE> — Specify the node ID for package deployment. If not specified, para will prompt
  • --no-deps — Skip processing dependencies
  • --password <PASSWORD> — Root user password. Prompts the user if not provided

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:​
  • --remote <REMOTE> — Deploy to a remote node

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

    Default value: false

  • --reset — Instead of upgrading the node in place, tear it down and rebuild it

    Default value: false

  • --node-domain <NODE_DOMAIN> — Override default domain

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

  • --aws-config <AWS_CONFIG> — Override the AWS config directory

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

  • --aws-config <AWS_CONFIG> — Override the AWS config directory

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
  • --ingress — Stop the ingress for the node
  • --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 docker list​

Usage: para docker list [OPTIONS] <COMMAND>

Subcommands:​
  • images —
  • containers —
  • networks —
  • volumes —
  • services —
Options:​

  • --all

    Default value: true

  • --filters <FILTERS>

para docker list images​

Usage: para docker list images

para docker list containers​

Usage: para docker list containers

para docker list networks​

Usage: para docker list networks

para docker list volumes​

Usage: para docker list volumes

para docker list services​

Usage: para docker list services

para docker command​

Usage: para docker command [OPTIONS] [COMMAND]...

Arguments:​
  • <COMMAND>
Options:​

  • --with-profile

    Default value: false

para catalog​

Usage: para catalog <COMMAND>

Subcommands:​
  • create —
  • update —

para catalog create​

Usage: para catalog create [OPTIONS]

Options:​

  • --system <SYSTEM> — System config filename

  • --node <NODE> — Node file or folder

  • --package <PACKAGE> — Package file or folder

  • --skillsets

  • -o, --outdir <OUTDIR> — Output directory

  • --format <FORMAT> — Catalog format

    Possible values: yaml, json, csv

  • --set <OVERRIDES> — Set a configuration value

para catalog update​

Usage: para catalog update [OPTIONS]

Options:​

  • --system <SYSTEM> — System config filename

  • --node <NODE> — Node file or folder

  • --package <PACKAGE> — Package file or folder

  • --skillsets

  • -o, --outdir <OUTDIR> — Output directory

  • --format <FORMAT> — Catalog format

    Possible values: yaml, json, csv

  • --set <OVERRIDES> — Set a configuration value

para remote​

Common configuration overrides

Usage: para remote [OPTIONS] <COMMAND>

Subcommands:​
  • ls —
  • setup —
  • deploy —
Options:​
  • --remote <REMOTE> — Remote vm to use
  • -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
  • --package-config <PACKAGE_CONFIG>
  • --node-config <NODE_CONFIG>
  • --set <OVERRIDES> — Set a configuration value
  • --node <NODE> — Specify the node ID for package deployment. If not specified, para will prompt
  • --no-deps — Skip processing dependencies
  • --password <PASSWORD> — Root user password. Prompts the user if not provided

para remote ls​

Usage: para remote ls

para remote setup​

Usage: para remote setup [OPTIONS] --host <HOST> --ssh-key <SSH_KEY>

Options:​
  • --host <HOST>
  • --ssh-key <SSH_KEY>
  • --username <USERNAME>

para remote deploy​

Usage: para remote deploy <COMMAND>

Subcommands:​
  • node —
  • package —

para remote deploy node​

Usage: para remote deploy node

para remote deploy package​

Usage: para remote deploy package

para federate​

Usage: para federate [OPTIONS]

Options:​
  • --to <TO> — The local node to federate to (i.e. node that provides skills to "from" node). If not specified, you must specify to-address
  • --from <FROM> — Which node to federate from (i.e. node that requests skills from "to" node). If this isn't specified, para will try and determine it from the local context
  • --from-address <FROM_ADDRESS> — Override the address of the "from" node
  • --from-insecure — If provided, the "from" node is assumed to not require login
  • --to-address <TO_ADDRESS> — Override the address of the "to" node
  • --to-insecure — If provided, the "to" node is assumed to not require login
  • --bidirectional — Indicates that skill requests can flow both directions
  • --from-password <FROM_PASSWORD>
  • --to-password <TO_PASSWORD>

para code​

Usage: para code <COMMAND>

Subcommands:​
  • download —

para code download​

Usage: para code download [OPTIONS] <NODE_ID> <ID>

Arguments:​
  • <NODE_ID> — Node ID in nodelist file, or node URL
  • <ID> — Actor ID to download code for
Options:​

  • -p, --password — Prompt for password

  • --user <USER> — Node local login username

  • -c, --cognito <COGNITO> — Cognito login username

  • --devkit — Login using devkit credentials

  • --insecure — Allow self-signed node server certificate

  • --actor-id <ACTOR_ID>

  • --cert <CERT>

  • --overwrite — Overwrite existing files

    Default value: false

  • --list — List the files that would be downloaded without downloading them

    Default value: false

para tree​

Usage: para tree [PACKAGES]...

Arguments:​
  • <PACKAGES>

para upload​

Usage: para upload [OPTIONS] <NODE_ID> [PACKAGE]

Arguments:​
  • <NODE_ID> — Node ID in nodelist file, or node URL
  • <PACKAGE> — Package file to upload
Options:​
  • -p, --password — Prompt for password
  • --user <USER> — Node local login username
  • -c, --cognito <COGNITO> — Cognito login username
  • --devkit — Login using devkit credentials
  • --insecure — Allow self-signed node server certificate
  • --actor-id <ACTOR_ID>
  • --cert <CERT>
  • --partition — Upload partition (e.g. overlay upload)
  • --skip — Ignore deployed actors that have release version and local changes
  • --forward <FORWARD> — Forward an actor's skills to user

para upload-state​

Usage: para upload-state [OPTIONS] <NODE_ID> [PACKAGE]

Arguments:​
  • <NODE_ID> — Node ID in nodelist file, or node URL
  • <PACKAGE> — Package file to upload
Options:​
  • -p, --password — Prompt for password
  • --user <USER> — Node local login username
  • -c, --cognito <COGNITO> — Cognito login username
  • --devkit — Login using devkit credentials
  • --insecure — Allow self-signed node server certificate
  • --actor-id <ACTOR_ID>
  • --cert <CERT>
  • --json — Output state as JSON

para deploy​

Usage: para deploy [OPTIONS] <NODE_ID> [PACKAGE]

Arguments:​
  • <NODE_ID> — Node ID in nodelist file, or node URL
  • <PACKAGE> — Package file to deploy
Options:​
  • -p, --password — Prompt for password
  • --user <USER> — Node local login username
  • -c, --cognito <COGNITO> — Cognito login username
  • --devkit — Login using devkit credentials
  • --insecure — Allow self-signed node server certificate
  • --actor-id <ACTOR_ID>
  • --cert <CERT>
  • --recreate — Force creating deployment resources, even if they already exist

para undeploy​

Usage: para undeploy [OPTIONS] <NODE_ID> [PACKAGE]

Arguments:​
  • <NODE_ID> — Node ID in nodelist file, or node URL
  • <PACKAGE> — Package file to deploy
Options:​
  • -p, --password — Prompt for password
  • --user <USER> — Node local login username
  • -c, --cognito <COGNITO> — Cognito login username
  • --devkit — Login using devkit credentials
  • --insecure — Allow self-signed node server certificate
  • --actor-id <ACTOR_ID>
  • --cert <CERT>

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:​
  • --remote <REMOTE> — Remote vm to use
  • -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
  • --package-config <PACKAGE_CONFIG>
  • --node-config <NODE_CONFIG>
  • --set <OVERRIDES> — Set a configuration value
  • --node <NODE> — Specify the node ID for package deployment. If not specified, para will prompt
  • --no-deps — Skip processing dependencies
  • --password <PASSWORD> — Root user password. Prompts the user if not provided

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 [OPTIONS] [COMMAND]

Subcommands:​
  • ls — List all saved contexts
  • select —
  • show — Show the full context (raw)
  • sync — Synchronize local context with existing nodes
  • clear — Remove one or more saved contexts
  • login — Refresh the login token for the current or specified node context
  • export — Export a node context to ~/.para/context/<id>.ctx.json (token stripped)
  • import — Import a node context from a .ctx.json file
  • domain — Manage Para installation on a remote domain
  • connect — Connect to the broker REPL for the selected context
  • deploy — Deploy to the selected context
  • federate — Federate the selected context with another node
Options:​
  • --id <ID> — Node ID to operate on. Uses the current context if omitted
  • --domain-id <DOMAIN_ID> — Domain ID to operate on. Uses the current context if omitted

para context ls​

List all saved contexts

Usage: para context ls

para context select​

Usage: para context select

para context show​

Show the full context (raw)

Usage: para context show [OPTIONS]

Options:​

  • -o, --output <OUTPUT> — Output format

    Possible values:

    • yaml: YAML format
    • json: JSON format
    • pretty: Rust debug (pretty) format

para context sync​

Synchronize local context with existing nodes

Usage: para context sync <BACKEND>

Arguments:​

  • <BACKEND>

    Possible values: docker, kubernetes, remote

para context clear​

Remove one or more saved contexts

Usage: para context clear [OPTIONS]

Options:​

  • --all — Remove all contexts

  • --backend <BACKEND> — Remove all contexts for a given backend type

    Possible values: docker, kubernetes, remote

  • --broken — Remove all contexts that could not be parsed (written by a newer version of Para)

para context login​

Refresh the login token for the current or specified node context

Usage: para context login [OPTIONS]

Options:​

  • --password <PASSWORD> — Password to use for login. Prompts interactively if omitted

  • --target <TARGET> — Which service to authenticate against

    Default value: broker

    Possible values:

    • broker: Authenticate against paranet-broker (PNCP/gRPC)
    • service: Authenticate against paranet-service (REST)

para context export​

Export a node context to ~/.para/context/<id>.ctx.json (token stripped)

Usage: para context export [OPTIONS]

Options:​

  • --dir <DIR> — Directory to export the context to. Defaults to ~/.para/context/

  • --stdout

    Default value: false

para context import​

Import a node context from a .ctx.json file

Usage: para context import <PATH>

Arguments:​
  • <PATH> — Path to the .ctx.json file to import

para context domain​

Manage Para installation on a remote domain

Usage: para context domain <DOMAIN_ID> <COMMAND>

Subcommands:​
  • remote — Install Para on a remote VM via SSH
  • docker —
Arguments:​
  • <DOMAIN_ID> — Identifier for this domain, used as the SSH config Host alias

para context domain remote​

Install Para on a remote VM via SSH

Usage: para context domain remote [OPTIONS] --ip <IP> --pem <PEM>

Options:​

  • --ip <IP> — IP address of the remote VM

  • --pem <PEM> — Path to the .pem file for SSH authentication

  • --user <USER> — SSH user

    Default value: ubuntu

  • --install

    Default value: false

para context domain docker​

Usage: para context domain docker --host <HOST>

Options:​
  • --host <HOST> — Docker host

para context connect​

Connect to the broker REPL for the selected context

Usage: para context connect [OPTIONS]

Options:​
  • -u, --user <USER> — Connect as this user instead of the context user
  • --endpoint <ENDPOINT> — Override the broker endpoint
  • --password <PASSWORD> — Password to use for login. Prompts interactively if omitted

para context deploy​

Deploy to the selected context

Usage: para context 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
  • --package-config <PACKAGE_CONFIG>
  • --node-config <NODE_CONFIG>
  • --set <OVERRIDES> — Set a configuration value
  • --no-deps — Skip processing dependencies
  • --password <PASSWORD> — Root user password. Prompts the user if not provided

para context deploy node​

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

Usage: para context deploy node [OPTIONS]

Options:​

  • --pull — Pull new images

    Default value: false

  • --reset — Instead of upgrading the node in place, tear it down and rebuild it

    Default value: false

  • --node-domain <NODE_DOMAIN> — Override default domain

para context deploy models​

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

Usage: para context deploy models [OPTIONS]

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

para context deploy actors​

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

Usage: para context 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

  • --aws-config <AWS_CONFIG> — Override the AWS config directory

para context deploy panels​

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

Usage: para context deploy panels [OPTIONS]

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

para context deploy sidecars​

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

Usage: para context deploy sidecars [OPTIONS]

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

para context deploy package​

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

Usage: para context 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

  • --aws-config <AWS_CONFIG> — Override the AWS config directory

para context federate​

Federate the selected context with another node

Usage: para context federate [OPTIONS]

Options:​
  • --to <TO> — The node that provides skills to the selected context. If omitted, use --to-address
  • --to-address <TO_ADDRESS> — Override the address of the to node
  • --to-insecure — Indicates that the to node requires login
  • --bidirectional — Indicates that skill requests can flow both directions
  • --password <PASSWORD> — Root user password. Prompts the user if not provided

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
  • platform — Updates the platform images for the current channel

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:​
  • --channel <CHANNEL>
  • --force — Force a redownload even if the file already exists

para update platform​

Updates the platform images for the current channel

Usage: para update platform [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 completion​

Generate shell completions

Usage: para completion <SHELL>

Arguments:​

  • <SHELL>

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