Back
    Developers

    CLI reference

    Every Pulse CLI command, grouped by workflow. Copy-paste-able. Same commands in the hosted playground and on your machine.

    In one line

    Scaffold, start, deploy, and send the first event — one command.

    bash
    1$ pulse quickstart hello-pulse
    2[1/4] scaffold a runnable app
    3[2/4] start a local Pulse (auto-logged-in)
    4[3/4] build + deploy the app
    5[4/4] send the sample event
    6🚀 hello-pulse is LIVE at http://localhost:9090

    Getting started

    pulse quickstart <name>

    Scaffold, start Pulse, deploy, send the first event.

    pulse new <name> --from-template <template>

    Start from a validated template — zero toolchain required.

    pulse server start --dev

    Start a local Pulse for development (foreground).

    App lifecycle

    pulse deploy <app>

    Compile handlers, generate the runtime, expose the API.

    pulse apps list

    List every deployed app on this Pulse.

    pulse apps describe <app>

    Show topics, endpoints, SDKs, and stage manifest.

    pulse apps rm <app>

    Remove an app and its topics.

    Events

    pulse events send <file.json> <app>

    Send an event to an app's ingress topic.

    pulse events tail <topic>

    Follow a topic live — every hop between stages is tailable.

    pulse events replay <topic> --from <offset>

    Deterministically replay a segment for debugging.

    Secrets

    pulse secrets set <name>

    Store a secret in the local vault (never written to pulse.yaml).

    pulse secrets list

    List secret names — values stay hidden.

    pulse secrets rm <name>

    Delete a secret from the vault.

    Topics & streams

    pulse topics list

    List every topic (ingress, inter-stage, sink).

    pulse topics describe <topic>

    Show retention, partitions, and current offset.

    Server

    pulse server status

    Health, uptime, and detached PID if any.

    pulse server stop

    Stop the local Pulse cleanly.

    pulse login

    Cache a JWT for the current profile.

    Diagnostics

    pulse doctor

    Check toolchain, ports, permissions, and vault state.

    pulse logs <app>

    Stream app logs with per-stage tags.

    pulse version

    Print CLI and engine version.

    Full CLI documentation