xbusctl

xbusctl account

list

Display accounts allowed to connect to Xbus, as a list.

Usage:
  xbusctl account list [flags]

Flags:
      --cert-details   Display cert details
      --csr-hash       Display CSR fingerprints (default true)
  -h, --help           help for list

Global Flags:
      --account-id string        Account ID
      --account-name string      Account Name
      --config string            config file; default is $HOME/.config/xbus/xbusctl.yaml)
  -d, --debug                    Enable debug mode
      --force-start              Enable force start (stay up even if the server is not reachable on start)
      --full-version             Show version and commit hash
      --nats-timeout duration    NATS Timeout
  -u, --nats-url string          NATS url (default "nats://localhost:4222")
      --sentry.dsn string        Sentry DSN
      --tls.certificate string   Certificate (a path or a PEM encoded cert)
      --tls.csr string           CSR (a path or a PEM encoded CSR)
      --tls.private-key string   Private key (a path or a PEM encoded key)
      --tls.timeout float        TLS Timeout (default 4)
      --trace                    Enable trace mode
      --version                  Show version
  -y, --yes                      Auto-answer 'yes' to any confirmation question

accept

Accept a pending account request so it can be allowed to connect to Xbus.

Usage:
  xbusctl account accept <identifier> [flags]

Flags:
      --cert-expire string   Expire date or duration for the account certificate (default "1y")
  -h, --help                 help for accept

Global Flags:
      --account-id string        Account ID
      --account-name string      Account Name
      --config string            config file; default is $HOME/.config/xbus/xbusctl.yaml)
  -d, --debug                    Enable debug mode
      --force-start              Enable force start (stay up even if the server is not reachable on start)
      --full-version             Show version and commit hash
      --nats-timeout duration    NATS Timeout
  -u, --nats-url string          NATS url (default "nats://localhost:4222")
      --sentry.dsn string        Sentry DSN
      --tls.certificate string   Certificate (a path or a PEM encoded cert)
      --tls.csr string           CSR (a path or a PEM encoded CSR)
      --tls.private-key string   Private key (a path or a PEM encoded key)
      --tls.timeout float        TLS Timeout (default 4)
      --trace                    Enable trace mode
      --version                  Show version
  -y, --yes                      Auto-answer 'yes' to any confirmation question

reject

Reject a pending account request; it will not be allowed to connect to Xbus.

Usage:
  xbusctl account reject <identifier> [flags]

Flags:
  -h, --help   help for reject

Global Flags:
      --account-id string        Account ID
      --account-name string      Account Name
      --config string            config file; default is $HOME/.config/xbus/xbusctl.yaml)
  -d, --debug                    Enable debug mode
      --force-start              Enable force start (stay up even if the server is not reachable on start)
      --full-version             Show version and commit hash
      --nats-timeout duration    NATS Timeout
  -u, --nats-url string          NATS url (default "nats://localhost:4222")
      --sentry.dsn string        Sentry DSN
      --tls.certificate string   Certificate (a path or a PEM encoded cert)
      --tls.csr string           CSR (a path or a PEM encoded CSR)
      --tls.private-key string   Private key (a path or a PEM encoded key)
      --tls.timeout float        TLS Timeout (default 4)
      --trace                    Enable trace mode
      --version                  Show version
  -y, --yes                      Auto-answer 'yes' to any confirmation question

delete

Delete an account.

Usage:
  xbusctl account delete <identifier> [flags]

Flags:
      --delete-actors   Force delete the related actors
  -h, --help            help for delete

Global Flags:
      --account-id string        Account ID
      --account-name string      Account Name
      --config string            config file; default is $HOME/.config/xbus/xbusctl.yaml)
  -d, --debug                    Enable debug mode
      --force-start              Enable force start (stay up even if the server is not reachable on start)
      --full-version             Show version and commit hash
      --nats-timeout duration    NATS Timeout
  -u, --nats-url string          NATS url (default "nats://localhost:4222")
      --sentry.dsn string        Sentry DSN
      --tls.certificate string   Certificate (a path or a PEM encoded cert)
      --tls.csr string           CSR (a path or a PEM encoded CSR)
      --tls.private-key string   Private key (a path or a PEM encoded key)
      --tls.timeout float        TLS Timeout (default 4)
      --trace                    Enable trace mode
      --version                  Show version
  -y, --yes                      Auto-answer 'yes' to any confirmation question

renew-apikey

Renew the APIKey of an account

Usage:
  xbusctl account renew-apikey [flags]

Flags:
  -h, --help   help for renew-apikey

Global Flags:
      --account-id string        Account ID
      --account-name string      Account Name
      --config string            config file; default is $HOME/.config/xbus/xbusctl.yaml)
  -d, --debug                    Enable debug mode
      --force-start              Enable force start (stay up even if the server is not reachable on start)
      --full-version             Show version and commit hash
      --nats-timeout duration    NATS Timeout
  -u, --nats-url string          NATS url (default "nats://localhost:4222")
      --sentry.dsn string        Sentry DSN
      --tls.certificate string   Certificate (a path or a PEM encoded cert)
      --tls.csr string           CSR (a path or a PEM encoded CSR)
      --tls.private-key string   Private key (a path or a PEM encoded key)
      --tls.timeout float        TLS Timeout (default 4)
      --trace                    Enable trace mode
      --version                  Show version
  -y, --yes                      Auto-answer 'yes' to any confirmation question

get-apikey

Get the current APIKey of an account

Usage:
  xbusctl account get-apikey [flags]

Flags:
  -h, --help   help for get-apikey

Global Flags:
      --account-id string        Account ID
      --account-name string      Account Name
      --config string            config file; default is $HOME/.config/xbus/xbusctl.yaml)
  -d, --debug                    Enable debug mode
      --force-start              Enable force start (stay up even if the server is not reachable on start)
      --full-version             Show version and commit hash
      --nats-timeout duration    NATS Timeout
  -u, --nats-url string          NATS url (default "nats://localhost:4222")
      --sentry.dsn string        Sentry DSN
      --tls.certificate string   Certificate (a path or a PEM encoded cert)
      --tls.csr string           CSR (a path or a PEM encoded CSR)
      --tls.private-key string   Private key (a path or a PEM encoded key)
      --tls.timeout float        TLS Timeout (default 4)
      --trace                    Enable trace mode
      --version                  Show version
  -y, --yes                      Auto-answer 'yes' to any confirmation question

set-apikey

Set the APIKey of an account

Usage:
  xbusctl account set-apikey [flags]

Flags:
  -h, --help   help for set-apikey

Global Flags:
      --account-id string        Account ID
      --account-name string      Account Name
      --config string            config file; default is $HOME/.config/xbus/xbusctl.yaml)
  -d, --debug                    Enable debug mode
      --force-start              Enable force start (stay up even if the server is not reachable on start)
      --full-version             Show version and commit hash
      --nats-timeout duration    NATS Timeout
  -u, --nats-url string          NATS url (default "nats://localhost:4222")
      --sentry.dsn string        Sentry DSN
      --tls.certificate string   Certificate (a path or a PEM encoded cert)
      --tls.csr string           CSR (a path or a PEM encoded CSR)
      --tls.private-key string   Private key (a path or a PEM encoded key)
      --tls.timeout float        TLS Timeout (default 4)
      --trace                    Enable trace mode
      --version                  Show version
  -y, --yes                      Auto-answer 'yes' to any confirmation question

xbusctl actor

create

Create a new actor

Usage:
  xbusctl actor create [flags]

Flags:
  -h, --help   help for create

Global Flags:
      --account-id string        Account ID
      --account-name string      Account Name
      --config string            config file; default is $HOME/.config/xbus/xbusctl.yaml)
  -d, --debug                    Enable debug mode
      --force-start              Enable force start (stay up even if the server is not reachable on start)
      --full-version             Show version and commit hash
      --id string                Actor's ID
      --name string              Actor's name
      --nats-timeout duration    NATS Timeout
  -u, --nats-url string          NATS url (default "nats://localhost:4222")
      --role string              Actor's role
      --sentry.dsn string        Sentry DSN
      --tls.certificate string   Certificate (a path or a PEM encoded cert)
      --tls.csr string           CSR (a path or a PEM encoded CSR)
      --tls.private-key string   Private key (a path or a PEM encoded key)
      --tls.timeout float        TLS Timeout (default 4)
      --trace                    Enable trace mode
      --type string              Actor's type (emitter, consumer)
      --version                  Show version
  -y, --yes                      Auto-answer 'yes' to any confirmation question

list

Usage:
  xbusctl actor list [flags]

Flags:
  -h, --help   help for list

Global Flags:
      --account-id string        Account ID
      --account-name string      Account Name
      --config string            config file; default is $HOME/.config/xbus/xbusctl.yaml)
  -d, --debug                    Enable debug mode
      --force-start              Enable force start (stay up even if the server is not reachable on start)
      --full-version             Show version and commit hash
      --id string                Actor's ID
      --name string              Actor's name
      --nats-timeout duration    NATS Timeout
  -u, --nats-url string          NATS url (default "nats://localhost:4222")
      --role string              Actor's role
      --sentry.dsn string        Sentry DSN
      --tls.certificate string   Certificate (a path or a PEM encoded cert)
      --tls.csr string           CSR (a path or a PEM encoded CSR)
      --tls.private-key string   Private key (a path or a PEM encoded key)
      --tls.timeout float        TLS Timeout (default 4)
      --trace                    Enable trace mode
      --type string              Actor's type (emitter, consumer)
      --version                  Show version
  -y, --yes                      Auto-answer 'yes' to any confirmation question

accept

Accept a pending actor so it can be allowed to connect to Xbus. An actor ID or name is required.

Usage:
  xbusctl actor accept [flags]

Flags:
  -h, --help   help for accept

Global Flags:
      --account-id string        Account ID
      --account-name string      Account Name
      --config string            config file; default is $HOME/.config/xbus/xbusctl.yaml)
  -d, --debug                    Enable debug mode
      --force-start              Enable force start (stay up even if the server is not reachable on start)
      --full-version             Show version and commit hash
      --id string                Actor's ID
      --name string              Actor's name
      --nats-timeout duration    NATS Timeout
  -u, --nats-url string          NATS url (default "nats://localhost:4222")
      --role string              Actor's role
      --sentry.dsn string        Sentry DSN
      --tls.certificate string   Certificate (a path or a PEM encoded cert)
      --tls.csr string           CSR (a path or a PEM encoded CSR)
      --tls.private-key string   Private key (a path or a PEM encoded key)
      --tls.timeout float        TLS Timeout (default 4)
      --trace                    Enable trace mode
      --type string              Actor's type (emitter, consumer)
      --version                  Show version
  -y, --yes                      Auto-answer 'yes' to any confirmation question

reject

Reject a pending actor so it can be allowed to connect to Xbus. An actor ID or name is required.

Usage:
  xbusctl actor reject [flags]

Flags:
  -h, --help   help for reject

Global Flags:
      --account-id string        Account ID
      --account-name string      Account Name
      --config string            config file; default is $HOME/.config/xbus/xbusctl.yaml)
  -d, --debug                    Enable debug mode
      --force-start              Enable force start (stay up even if the server is not reachable on start)
      --full-version             Show version and commit hash
      --id string                Actor's ID
      --name string              Actor's name
      --nats-timeout duration    NATS Timeout
  -u, --nats-url string          NATS url (default "nats://localhost:4222")
      --role string              Actor's role
      --sentry.dsn string        Sentry DSN
      --tls.certificate string   Certificate (a path or a PEM encoded cert)
      --tls.csr string           CSR (a path or a PEM encoded CSR)
      --tls.private-key string   Private key (a path or a PEM encoded key)
      --tls.timeout float        TLS Timeout (default 4)
      --trace                    Enable trace mode
      --type string              Actor's type (emitter, consumer)
      --version                  Show version
  -y, --yes                      Auto-answer 'yes' to any confirmation question

xbusctl pipeline

list

List pipelines, optionnaly filtered by name

Usage:
  xbusctl pipeline list [name] [flags]

Flags:
  -h, --help   help for list

Global Flags:
      --account-id string        Account ID
      --account-name string      Account Name
      --config string            config file; default is $HOME/.config/xbus/xbusctl.yaml)
  -d, --debug                    Enable debug mode
      --force-start              Enable force start (stay up even if the server is not reachable on start)
      --full-version             Show version and commit hash
      --nats-timeout duration    NATS Timeout
  -u, --nats-url string          NATS url (default "nats://localhost:4222")
      --sentry.dsn string        Sentry DSN
      --tls.certificate string   Certificate (a path or a PEM encoded cert)
      --tls.csr string           CSR (a path or a PEM encoded CSR)
      --tls.private-key string   Private key (a path or a PEM encoded key)
      --tls.timeout float        TLS Timeout (default 4)
      --trace                    Enable trace mode
      --version                  Show version
  -y, --yes                      Auto-answer 'yes' to any confirmation question

push

Pipeline subcommands allow to list and modify pipelines

Usage:
  xbusctl pipeline [command]

Available Commands:
  get         Get a pipeline definition
  list        List pipelines, optionnaly filtered by name
  save        Save a pipeline
  status      Change the status of a pipeline version

Flags:
  -h, --help   help for pipeline

Global Flags:
      --account-id string        Account ID
      --account-name string      Account Name
      --config string            config file; default is $HOME/.config/xbus/xbusctl.yaml)
  -d, --debug                    Enable debug mode
      --force-start              Enable force start (stay up even if the server is not reachable on start)
      --full-version             Show version and commit hash
      --nats-timeout duration    NATS Timeout
  -u, --nats-url string          NATS url (default "nats://localhost:4222")
      --sentry.dsn string        Sentry DSN
      --tls.certificate string   Certificate (a path or a PEM encoded cert)
      --tls.csr string           CSR (a path or a PEM encoded CSR)
      --tls.private-key string   Private key (a path or a PEM encoded key)
      --tls.timeout float        TLS Timeout (default 4)
      --trace                    Enable trace mode
      --version                  Show version
  -y, --yes                      Auto-answer 'yes' to any confirmation question

Use "xbusctl pipeline [command] --help" for more information about a command.

xbusctl key

generate

Generate a private key named based on the selected user.

Usage:
  xbusctl key generate [flags]

Flags:
  -h, --help   help for generate

Global Flags:
      --account-id string        Account ID
      --account-name string      Account Name
      --config string            config file; default is $HOME/.config/xbus/xbusctl.yaml)
  -d, --debug                    Enable debug mode
      --force-start              Enable force start (stay up even if the server is not reachable on start)
      --full-version             Show version and commit hash
      --nats-timeout duration    NATS Timeout
  -u, --nats-url string          NATS url (default "nats://localhost:4222")
      --sentry.dsn string        Sentry DSN
      --tls.certificate string   Certificate (a path or a PEM encoded cert)
      --tls.csr string           CSR (a path or a PEM encoded CSR)
      --tls.private-key string   Private key (a path or a PEM encoded key)
      --tls.timeout float        TLS Timeout (default 4)
      --trace                    Enable trace mode
      --version                  Show version
  -y, --yes                      Auto-answer 'yes' to any confirmation question

xbusctl ps

[default]

Process list

Usage:
  xbusctl ps [flags]
  xbusctl ps [command]

Available Commands:
  cancel      Cancel a process
  export      Export process data
  pause       Pause a process
  purge       Purge process data
  resume      Resume a process

Flags:
      --all                               Include processes with any status
      --envelope-id string                Include processes that are related to one on the given envelopes
  -h, --help                              help for ps
      --live                              Include processes that are not terminated
      --pipeline string                   Include pipelines matching the selection (ex: name1,name2==version,name3)
      --status-changed-since duration     Status of the process changed at least once during the given duration before now
      --status-done                       Include processes in the 'done' status
      --status-error                      Include processes in the 'error' status
      --status-initial                    Include processes in the 'initial' status
      --status-paused                     Include processes in the 'paused' status
      --status-running                    Include processes in the 'running' status
      --status-unchanged-since duration   Status of the process did not change during the given duration before now
      --terminated                        Include processes that are terminated

Global Flags:
      --account-id string        Account ID
      --account-name string      Account Name
      --config string            config file; default is $HOME/.config/xbus/xbusctl.yaml)
  -d, --debug                    Enable debug mode
      --force-start              Enable force start (stay up even if the server is not reachable on start)
      --full-version             Show version and commit hash
      --nats-timeout duration    NATS Timeout
  -u, --nats-url string          NATS url (default "nats://localhost:4222")
      --sentry.dsn string        Sentry DSN
      --tls.certificate string   Certificate (a path or a PEM encoded cert)
      --tls.csr string           CSR (a path or a PEM encoded CSR)
      --tls.private-key string   Private key (a path or a PEM encoded key)
      --tls.timeout float        TLS Timeout (default 4)
      --trace                    Enable trace mode
      --version                  Show version
  -y, --yes                      Auto-answer 'yes' to any confirmation question

Use "xbusctl ps [command] --help" for more information about a command.

pause

Pause a process

Usage:
  xbusctl ps pause [flags]

Flags:
  -h, --help   help for pause

Global Flags:
      --account-id string                 Account ID
      --account-name string               Account Name
      --all                               Include processes with any status
      --config string                     config file; default is $HOME/.config/xbus/xbusctl.yaml)
  -d, --debug                             Enable debug mode
      --envelope-id string                Include processes that are related to one on the given envelopes
      --force-start                       Enable force start (stay up even if the server is not reachable on start)
      --full-version                      Show version and commit hash
      --live                              Include processes that are not terminated
      --nats-timeout duration             NATS Timeout
  -u, --nats-url string                   NATS url (default "nats://localhost:4222")
      --pipeline string                   Include pipelines matching the selection (ex: name1,name2==version,name3)
      --sentry.dsn string                 Sentry DSN
      --status-changed-since duration     Status of the process changed at least once during the given duration before now
      --status-done                       Include processes in the 'done' status
      --status-error                      Include processes in the 'error' status
      --status-initial                    Include processes in the 'initial' status
      --status-paused                     Include processes in the 'paused' status
      --status-running                    Include processes in the 'running' status
      --status-unchanged-since duration   Status of the process did not change during the given duration before now
      --terminated                        Include processes that are terminated
      --tls.certificate string            Certificate (a path or a PEM encoded cert)
      --tls.csr string                    CSR (a path or a PEM encoded CSR)
      --tls.private-key string            Private key (a path or a PEM encoded key)
      --tls.timeout float                 TLS Timeout (default 4)
      --trace                             Enable trace mode
      --version                           Show version
  -y, --yes                               Auto-answer 'yes' to any confirmation question

resume

Resume a process

Usage:
  xbusctl ps resume [flags]

Flags:
  -h, --help   help for resume

Global Flags:
      --account-id string                 Account ID
      --account-name string               Account Name
      --all                               Include processes with any status
      --config string                     config file; default is $HOME/.config/xbus/xbusctl.yaml)
  -d, --debug                             Enable debug mode
      --envelope-id string                Include processes that are related to one on the given envelopes
      --force-start                       Enable force start (stay up even if the server is not reachable on start)
      --full-version                      Show version and commit hash
      --live                              Include processes that are not terminated
      --nats-timeout duration             NATS Timeout
  -u, --nats-url string                   NATS url (default "nats://localhost:4222")
      --pipeline string                   Include pipelines matching the selection (ex: name1,name2==version,name3)
      --sentry.dsn string                 Sentry DSN
      --status-changed-since duration     Status of the process changed at least once during the given duration before now
      --status-done                       Include processes in the 'done' status
      --status-error                      Include processes in the 'error' status
      --status-initial                    Include processes in the 'initial' status
      --status-paused                     Include processes in the 'paused' status
      --status-running                    Include processes in the 'running' status
      --status-unchanged-since duration   Status of the process did not change during the given duration before now
      --terminated                        Include processes that are terminated
      --tls.certificate string            Certificate (a path or a PEM encoded cert)
      --tls.csr string                    CSR (a path or a PEM encoded CSR)
      --tls.private-key string            Private key (a path or a PEM encoded key)
      --tls.timeout float                 TLS Timeout (default 4)
      --trace                             Enable trace mode
      --version                           Show version
  -y, --yes                               Auto-answer 'yes' to any confirmation question

cancel

Cancel a process

Usage:
  xbusctl ps cancel [flags]

Flags:
  -h, --help   help for cancel

Global Flags:
      --account-id string                 Account ID
      --account-name string               Account Name
      --all                               Include processes with any status
      --config string                     config file; default is $HOME/.config/xbus/xbusctl.yaml)
  -d, --debug                             Enable debug mode
      --envelope-id string                Include processes that are related to one on the given envelopes
      --force-start                       Enable force start (stay up even if the server is not reachable on start)
      --full-version                      Show version and commit hash
      --live                              Include processes that are not terminated
      --nats-timeout duration             NATS Timeout
  -u, --nats-url string                   NATS url (default "nats://localhost:4222")
      --pipeline string                   Include pipelines matching the selection (ex: name1,name2==version,name3)
      --sentry.dsn string                 Sentry DSN
      --status-changed-since duration     Status of the process changed at least once during the given duration before now
      --status-done                       Include processes in the 'done' status
      --status-error                      Include processes in the 'error' status
      --status-initial                    Include processes in the 'initial' status
      --status-paused                     Include processes in the 'paused' status
      --status-running                    Include processes in the 'running' status
      --status-unchanged-since duration   Status of the process did not change during the given duration before now
      --terminated                        Include processes that are terminated
      --tls.certificate string            Certificate (a path or a PEM encoded cert)
      --tls.csr string                    CSR (a path or a PEM encoded CSR)
      --tls.private-key string            Private key (a path or a PEM encoded key)
      --tls.timeout float                 TLS Timeout (default 4)
      --trace                             Enable trace mode
      --version                           Show version
  -y, --yes                               Auto-answer 'yes' to any confirmation question

xbusctl register

Generate a Certificate Signing Request then send it over to Xbus through the
unencrypted "registration" channel. This xbusctl will only be allowed to send
Xbus actual commands once accepted on the Xbus side.
This command also outputs the command one has to run on the Xbus side to accept
the registration request.

Usage:
  xbusctl register [flags]

Flags:
  -h, --help   help for register

Global Flags:
      --account-id string        Account ID
      --account-name string      Account Name
      --config string            config file; default is $HOME/.config/xbus/xbusctl.yaml)
  -d, --debug                    Enable debug mode
      --force-start              Enable force start (stay up even if the server is not reachable on start)
      --full-version             Show version and commit hash
      --nats-timeout duration    NATS Timeout
  -u, --nats-url string          NATS url (default "nats://localhost:4222")
      --sentry.dsn string        Sentry DSN
      --tls.certificate string   Certificate (a path or a PEM encoded cert)
      --tls.csr string           CSR (a path or a PEM encoded CSR)
      --tls.private-key string   Private key (a path or a PEM encoded key)
      --tls.timeout float        TLS Timeout (default 4)
      --trace                    Enable trace mode
      --version                  Show version
  -y, --yes                      Auto-answer 'yes' to any confirmation question