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)

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

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")

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

reject

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

Usage:
  xbusctl account reject <identifier> [flags]

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

xbusctl actor

create

Create a new actor

Usage:
  xbusctl actor create [flags]

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

list

Usage:
  xbusctl actor list [flags]

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

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]

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

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]

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

xbusctl graph

query

Search for graphs with the given name

Usage:
  xbusctl graph query <name> [flags]

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

push

Graph subcommands allow to list and modify graphs

Usage:
  xbusctl graph [command]

Available Commands:
  query       Search for graphs with the given name
  get         Get a graph definition
  save        Save a graph
  status      Change the status of a graph version

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

Use "xbusctl graph [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]

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

xbusctl ps

[default]

Process list

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

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

Flags:
      --all                               Include processes with any status
      --envelope-id string                Include processes that are related to one on the given envelopes
      --live                              Include processes that are not terminated
      --status-changed-since duration     Status of the process changed at least once during the given duration before now (default 0s)
      --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 (default 0s)
      --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
  -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

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

pause

Pause a process

Usage:
  xbusctl ps pause [flags]

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
  -u, --nats-url string                   NATS url (default "nats://localhost:4222")
      --sentry.dsn string                 Sentry DSN
      --status-changed-since duration     Status of the process changed at least once during the given duration before now (default 0s)
      --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 (default 0s)
      --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

resume

Resume a process

Usage:
  xbusctl ps resume [flags]

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
  -u, --nats-url string                   NATS url (default "nats://localhost:4222")
      --sentry.dsn string                 Sentry DSN
      --status-changed-since duration     Status of the process changed at least once during the given duration before now (default 0s)
      --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 (default 0s)
      --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

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]

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

Previous page

xbusd

Next page

xbus-client

This Page