Skip to main content
Version: 1.x

Command-Line Help for wasmcloud

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

Command Overview:

wasmcloud​

wasmCloud host runtime

Usage: wasmcloud [OPTIONS]

Options:​

  • --trace-level <TRACE_LEVEL> — Controls the verbosity of traces emitted from the wasmCloud host

    Default value: INFO

  • --log-level <LOG_LEVEL> — Controls the verbosity of logs from the wasmCloud host

    Default value: INFO

  • --nats-host <NATS_HOST> — NATS server host to connect to

    Default value: 127.0.0.1

  • --nats-port <NATS_PORT> — NATS server port to connect to

    Default value: 4222

  • --nats-jwt <NATS_JWT> — A user JWT to use to authenticate to NATS

  • --nats-seed <NATS_SEED> — A seed nkey to use to authenticate to NATS

  • --nats-creds <NATS_CREDS> — A NATS credentials file that contains the JWT and seed for authenticating to NATS

  • -x, --lattice <LATTICE> — The lattice the host belongs to

    Default value: default

  • --host-seed <HOST_SEED> — The seed key (a printable 256-bit Ed25519 private key) used by this host to generate its public key

  • --provider-shutdown-delay-ms <PROVIDER_SHUTDOWN_DELAY> — Delay, in milliseconds, between requesting a provider shut down and forcibly terminating its process

    Default value: 300

  • --allow-latest — Determines whether OCI images tagged latest are allowed to be pulled from OCI registries and started

  • --allowed-insecure <ALLOWED_INSECURE> — A comma-separated list of OCI hosts to which insecure (non-TLS) connections are allowed

  • --js-domain <JS_DOMAIN> — NATS Jetstream domain name

  • --config-service-enabled — Denotes if a wasmCloud host should issue requests to a config service on startup

  • --allow-file-load — Denotes if a wasmCloud host should allow starting components from the file system

    Default value: false

  • --enable-structured-logging — Enable JSON structured logging from the wasmCloud host

  • -l, --label <LABEL> — Start the host with a set of labels, can be specified multiple times. This can alternatively be specified via environment variables prefixed with WASMCLOUD_LABEL_, e.g. WASMCLOUD_LABEL_foo=bar

  • --policy-topic <POLICY_TOPIC> — If provided, enables policy checks on start actions and component invocations

  • --policy-changes-topic <POLICY_CHANGES_TOPIC> — If provided, allows the host to subscribe to updates on past policy decisions. Requires policy_topic to be set

  • --max-execution-time-ms <MAX_EXECUTION_TIME> — If provided, allows to set a custom Max Execution time for the Host in ms

    Default value: 600000

  • --max-linear-memory-bytes <MAX_LINEAR_MEMORY> — The maximum amount of memory bytes that a component can allocate (default 256 MiB)

    Default value: 268435456

  • --max-component-size-bytes <MAX_COMPONENT_SIZE> — The maximum byte size of a component binary that can be loaded (default 50 MiB)

    Default value: 52428800

  • --max-components <MAX_COMPONENTS> — The maximum number of components that can be run simultaneously

    Default value: 10000

  • --policy-timeout-ms <POLICY_TIMEOUT_MS> — If provided, allows setting a custom timeout for requesting policy decisions. Defaults to one second. Requires policy_topic to be set

  • --secrets-topic <SECRETS_TOPIC_PREFIX> — If provided, enables interfacing with a secrets backend for secret retrieval over the given topic prefix. Must not be empty

  • --oci-registry <OCI_REGISTRY> — Used in tandem with oci_user and oci_password to override credentials for a specific OCI registry

  • --oci-user <OCI_USER> — Username for the OCI registry specified by oci_registry

  • --oci-password <OCI_PASSWORD> — Password for the OCI registry specified by oci_registry

  • --enable-observability — Determines whether observability should be enabled

  • --override-observability-endpoint <OBSERVABILITY_ENDPOINT> — Overrides the OpenTelemetry endpoint used for emitting traces, metrics and logs

  • --flame-graph <FLAME_GRAPH> — Path to generate flame graph at

  • --tls-ca-path <TLS_CA_PATHS> — Configures the set of certificate authorities as repeatable set of file paths to load into the OCI and OpenTelemetry clients