Skip to main content

Get started with Tickr Lite

Prerequisites​

  • An invitation.json file from your Tickr operator.
  • Linux x86-64, Linux ARM64, or Apple silicon.
  • curl, wget, and tar.

Install Nix​

curl -fsSL https://install.determinate.systems/nix |
  sh -s -- install --determinate --no-confirm
Check the installation

Open a new terminal, then run:

nix --version
nix flake --help >/dev/null

Install Nickel​

nix profile add nixpkgs#nickel
export PATH="$HOME/.nix-profile/bin:$PATH"
nickel --version

Tickr Lite supports Nickel 1.16.0 and 1.17.0. Add $HOME/.nix-profile/bin to your shell startup file if a new terminal cannot find nickel.

Install Tickr Lite​

Choose your platform. The commands use the Tickr version documented by this release of the site.

VERSION=0.1.5
TARGET=x86_64-unknown-linux-gnu
ARCHIVE="tickr-lite-v${VERSION}-${TARGET}.tar.gz"

wget "https://github.com/tickr-io/tickr-cli/releases/download/v${VERSION}/${ARCHIVE}"
wget "https://github.com/tickr-io/tickr-cli/releases/download/v${VERSION}/${ARCHIVE}.sha256"
sha256sum --check "${ARCHIVE}.sha256"
tar -xzf "${ARCHIVE}"
cd "${ARCHIVE%.tar.gz}"
macOS Gatekeeper

If macOS blocks the downloaded binaries, run the following command from inside the extracted Tickr Lite directory:

xattr -dr com.apple.quarantine .

This removes the quarantine attribute from the verified release.

Keep the extracted directory intact; it contains the executables, Core DSL, Console, examples, and notices for the same release.

Set up Tickr Lite​

./tickr-cli setup --from invitation.json

Setup validates the invitation, creates the private profile/config.json, defaults durable state to data/ inside this extracted release, and applies the Tickr Lite SQLite migrations. Each extracted release therefore owns its Tenant profile and durable state without shell configuration.

Explore Tickr in the Console​

./tickr-cli examples run hello-world runtime-patch polyglot

The command starts tickr-lite when needed, opens the embedded Console at http://127.0.0.1:3000/, and registers and triggers all three workflows as their builds become ready. The polyglot workflow runs Python, JavaScript, Go, and Rust Tasks with one predefined greeting.

After the initial Runs settle, the interactive session remains open:

Commands: run <example>, list, open, help, quit
tickr › run <example>

Use list to see packaged examples, run <example> to trigger another Run, and open to reopen the Console. Press Ctrl-C or enter quit when finished. The command stops only the tickr-lite process it started.

Start Tickr Lite later​

./tickr-lite

The standalone runtime loads the saved setup profile and keeps the API and Console available until interrupted.