---
title: "Use Examples"
url: "https://docs.caracal.run/examples/"
markdown_url: "https://docs.caracal.run/markdown/examples.md"
description: "Choose the right runnable example for learning, automation, validation, or full reference-lab integration."
page_type: "landing"
concepts: []
requires: []
---

# Use Examples

Canonical URL: https://docs.caracal.run/examples/
Markdown URL: https://docs.caracal.run/markdown/examples.md
Description: Choose the right runnable example for learning, automation, validation, or full reference-lab integration.
Page type: landing
Concepts: none
Requires: none

---

Examples show Caracal integrated into concrete applications and automation scripts. Use them after the first tutorials when you want runnable code that matches a specific integration job.

## Choose an example

| Goal | Start here | Code path |
| --- | --- | --- |
| Need a local protected target for the first Gateway call. | [Run Echo Upstream](/examples/echo-upstream/) | `examples/echoUpstream` |
| Want to automate zone setup from a script or pipeline through the Control API. | [Bootstrap Control State](/examples/control-bootstrap/) | `examples/controlBootstrap` |
| Need to prove a provider-backed resource is ready. | [Check Provider Readiness](/examples/provider-preflight/) | `examples/providerPreflight` |
| Need to turn a denial into a safe policy fix. | [Iterate Policy Safely](/examples/policy-iterate/) | `examples/policyIterate` |
| Want to launch a plain CLI agent with injected provider credentials. | [Launch Research Agent](/examples/research-agent/) | `examples/ResearchAgent` |
| Want a full app reference lab with agents, providers, Gateway, STS, and Console inspection. | [Run Lynx Capital](/examples/lynx-capital/) | `examples/lynxCapital` |

## Recommended order

1. Start with [Run Echo Upstream](/examples/echo-upstream/) if you have not completed a Gateway-mediated request yet.
2. Use [Bootstrap Control State](/examples/control-bootstrap/) when automation should own zone setup instead of manual Console clicks.
3. Run [Check Provider Readiness](/examples/provider-preflight/) before the first real provider-backed Gateway call.
4. Use [Iterate Policy Safely](/examples/policy-iterate/) when an audit denial needs to become a tested policy change.
5. Try [Launch Research Agent](/examples/research-agent/) to see `caracal run` inject provider-native credentials into an existing-style CLI process.
6. Study [Run Lynx Capital](/examples/lynx-capital/) when you need a full app topology and live Console inspection path.

## Use examples safely

- Start Caracal through the released runtime and Console path described by the example.
- Use Console for zones, applications, providers, resources, policies, control keys, and runtime profiles.
- Keep example fixtures inside their own `examples/<name>` directory.
- Run each example's offline tests before adapting it.
- Do not commit provider secrets, admin tokens, or real third-party credentials.

## Related sections

- [Get Started](/get-started/)
- [Tutorials](/tutorials/)
- [Guides](/guides/)
- [SDKs](/sdks/)
- [Runtime and Console](/runtime-console/)