Skip to content

Instantly share code, notes, and snippets.

@danieldocki

danieldocki/kamal.sh

Forked from jweslley/kamal.sh
Created April 17, 2025 17:50
Show Gist options
  • Save danieldocki/ec86a6b879a6e1ece8e3f8e2219c7164 to your computer and use it in GitHub Desktop.
Save danieldocki/ec86a6b879a6e1ece8e3f8e2219c7164 to your computer and use it in GitHub Desktop.
Download ZIP

Revisions

  1. @jweslley jweslley created this gist Apr 17, 2025.
    51 changes: 51 additions & 0 deletions kamal.sh
    View file
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,51 @@
    # Kamal commands cheat sheet

    # The init command is used to create the config and secrets files once after Kamal is added to the app.
    $ kamal init

    # Install Docker on all target hosts
    $ kamal server

    # Aliases
    # Kamal defines `kamal shell` out of the box, I usually add `kamal console` to quickly access the Rails console.
    $ kamal shell [-d production]
    # app exec -i --reuse "bin/rails console"
    $ kamal console [-d production]

    # Deploy app [to the staging environment]
    $ kamal deploy [-d staging]

    # Rollback app [to the VERSION] [in the staging environment]
    $ kamal rollback [VERSION] [-d staging]

    # Building images
    # Most of the time you won't use the `kamal build` command directly,
    # since it primarily used by `kamal deploy` and `kamal redeploy`.
    # However, you can also use it to build the app image without pushing it, which is useful for testing.
    $ kamal build dev

    # Below are several commands to read the logs of the app and its accessories.
    $ kamal app logs [--roles=web -n 100 -f]
    $ kamal app logs [--primary -n 100 -f]
    $ kamal app logs [--hosts=<ip_address>&gt; -n 100 -f]
    $ kamal audit

    # Show logs for the PgHero accessory [for the staging environment]
    $ kamal accessory logs pghero [-d staging]
    # Show logs for the proxy server [for the staging environment]
    $ kamal proxy logs [-d staging]

    # Show combined config (including secrets) [for the staging environment]. Can be useful to debug and in case you forgot your server ip-address.
    $ kamal config [-d staging]

    # Print secrets to stdout [for the staging environment]
    $ kamal secrets print [-d staging]

    # Show details about all containers grouped by role [for the staging environment]
    $ kamal details [-d staging]

    # Show details only about the app containers [for the staging environment], [for the web role]
    $ kamal app details [-d staging] [--roles=web]

    # Show details only about the PgHero accessory containers [for the staging environment]
    $ kamal accessory details pghero -d staging