Skip to Content
⚠️ v0.1 — Early preview. APIs and schema may change.
Getting Started

Getting Started

Install Zil and run your first agent in five minutes.

Prerequisites

  • Python 3.11+
  • pip (or pipx)

1. Install

pip install 'zil-ai[adk]'

Verify:

zil --version # zil, version 0.1.12

2. Create a project

zil init my-agent

The CLI prompts for your LLM provider (Gemini, Anthropic, OpenAI, or Vertex AI), then scaffolds the project, creates a virtual environment, and installs dependencies.

Use --non-interactive to accept all defaults:

zil init my-agent --non-interactive

3. Configure your API key

cd my-agent source .venv/bin/activate cp my_agent/.env.example my_agent/.env

Edit my_agent/.env and add your API key. The default provider is Gemini — get a key at aistudio.google.com/apikey .

For other providers, see Adapters — LLM.

4. Run your agent

# Interactive CLI zil run # Or browser-based chat UI zil web

5. What to edit

FilePurpose
identity/persona.mdWho the agent is
identity/instructions.mdHow the agent behaves
identity/guardrails.yamlHard rules and boundaries
adapters/llm.yamlLLM provider and model
my_agent/agent.pyTools and logic

The generated agent.py uses one function to wire everything:

import zil root_agent = zil.create_agent( tools=[], # add your tool functions here )

See SDK Reference for all create_agent() options.

What’s next

GoalCommand / Page
Validate your projectzil validateCLI Reference
Security auditzil auditCLI Reference
Write and run evalszil evalEvaluation
Test in Dockerzil web --docker --traceCLI Reference
Package and publishzil packzil pushPackaging
Deploy to Cloud Runzil deployCLI Reference
Set up tracingObservability
Guardrails referenceIdentity — Guardrails