Getting Started
Install Telar, understand the workflow, and run your first command.
Requirements
- Claude Code or Codex installed and authenticated.
- A React Native or Flutter project (or start a new one with
/tl-telar:create-app). - For simulator automation: Xcode (iOS) and/or Android SDK with an emulator.
Installation
Claude Code
# Add the marketplace
claude plugin marketplace add zekiyugnak/telar-framework
# Install the plugin
claude plugin install tl-telar@telar
After installation, restart Claude Code to load the plugin. All commands are namespaced under /tl-telar:.
Codex
# Latest development build
codex plugin marketplace add zekiyugnak/telar-framework --ref develop
codex plugin add tl-telar@telar
codex plugin list --marketplace telar
For the stable main branch, replace --ref develop with --ref main. If the marketplace was already added with another ref, remove tl-telar@telar and the telar marketplace, then add it again with the ref you want.
Start a new Codex thread and invoke Telar with @tl-telar or bundled skills such as $create-app, $review-plan, and $orchestrate. Plugin installation is separate from the optional adapters.codex setting used for external orchestration delegation.
Quick start
In Claude Code, use the slash-command form below. In Codex, use the plugin context with @tl-telar or call the bundled skill names directly, for example $orchestrate.
| Goal | Command |
|---|---|
| New app from scratch | /tl-telar:create-app [description] |
| Add a feature | /tl-telar:add-feature [feature] |
| Run tests | /tl-telar:test-app [scope] |
| Code review | /tl-telar:review-code [path] |
| End-to-end orchestrated build | /tl-telar:orchestrate <task> |
| Release to stores | /tl-telar:release-app |
See the full command reference for all 23 workflows.
The 8-step workflow
Telar structures feature work into eight phases. Each maps to skills and rules that enforce the discipline automatically.
- Explore — read the existing codebase first (
codebase-firstrule). - Requirements — establish what to build in
REQUIREMENTS.md. - Research — decide how to build it in
RESEARCH.md. - Plan — break work into atomic tasks in
PLAN.md+PROGRESS.md. - Build — iterate with simulator verification.
- Debug — find the root cause before fixing.
- Verify — require fresh evidence before claiming done.
- Review — two-stage gates: requirement compliance + code quality.
Automatic behaviors
Some safeguards run with no action needed, via hooks and always-on rules:
- Codebase exploration is encouraged before code generation.
- Security reminders surface for sensitive operations.
- Pre-build checks flag common issues (e.g. localhost URLs in production paths).
- After compaction or restart, a SessionStart hook re-primes orchestration context.
Optional: orchestrated mode
Orchestration is strictly opt-in. Legacy commands work unchanged until you run setup.
# One-time opt-in: framework detection + .tl-telar/ skeleton
/tl-telar:setup-orchestration
# Run the full pipeline: design gate → plan gate → 4-phase execution
/tl-telar:orchestrate <task>