Skip to main content

Overview

The examples are the fastest way to study larger Cowboy actor patterns after you have a Cowboy source checkout. If you are starting from an installed cowboy CLI only, begin with Quickstart and Your First Actor; those pages work from a normal project directory. The source checkout’s examples/ directory is split into three tracks:
  • examples/core/ — numbered new-developer curriculum.
  • examples/gallery/ — unnumbered applied showcases and product-shaped patterns.
  • examples/tooling/ — local testing and workflow helpers.
The shared sweep runs the active core curriculum by default and can switch to the gallery with --gallery.

Run The Sweep

Run commands from the source checkout’s examples/ directory:
Run one swept example by passing its current path, id, or slug:

What You Learn

Core Curriculum

Some heavier gallery examples are intentionally outside the default sweep because they require external credentials, extra Python packages, CBSS-capable infrastructure, or app setup. Use each example’s local README.md and smoke command for those paths.

Suggested Path

If you want a short builder path through the current examples, study these in order:
  1. core/00-quickstart-hello
  2. core/01-state-events-queries
  3. core/02-senders-and-permissions
  4. core/03-two-actor-messaging
  5. core/08-minimal-runner-continuation
  6. core/09-runner-llm
  7. core/12-capstone-agent
That path moves from basic chain interactions to state, permissions, actor messaging, runner continuations, LLM-backed callbacks, and a complete capstone workflow.

Targeting

  • --server mesa uses ${MESA_RPC_URL:-http://validator.mesa.cowboylabs.net:4000}
  • --server canyon uses ${CANYON_RPC_URL:-http://validator.canyon.cowboylabs.net:4000}
  • --server local uses ${LOCAL_RPC_URL:-http://localhost:${RPC_PORT:-5000}}
  • --server http://... or --server https://... targets a custom RPC URL
  • --spawn-local starts an isolated temporary local validator for the run
  • --verbose prints the full raw Cowboy CLI output instead of the compact command/result view
Runner-backed examples require at least one registered runner on the target network. Keep the runner’s stake and operating balance separate: stake is locked for eligibility, while the spendable balance pays gas for heartbeat transactions and result submissions.

See Also