> ## Documentation Index
> Fetch the complete documentation index at: https://unmute.ai/llms.txt
> Use this file to discover all available pages before exploring further.
> ## Agent Instructions
> Unmute compiles to exactly three targets. Pipecat and LiveKit are code targets: compile writes a Python project you run. SLNG is a hosted target: compile writes a deployment body and SLNG runs the agent, so it has no `unmute dev`. Those three are the only values `provider` accepts in `targets.yaml`. Deepgram and ElevenLabs appear in these docs as model vendors, which is not the same thing as a target, and `slng` is both.
> The Go structs in `internal/spec` and `internal/ir` are the schema truth. Check a field against them, or run `unmute validate`, rather than against what you remember.
# unmute init
> Create an agent package, or give a coding assistant a draft with your company rules attached.
Create an agent package your coding assistant can complete within your company's rules.
The manifest sets the allowed choices. `init` copies that contract into a
package; the assistant writes the use case. **Create, complete, check** is the
whole workflow. The CLI does not call a language model for you.
On this page:
* [Quickstart](#quickstart) - start from a saved manifest
* [Choose the contract](#1-choose-the-contract) - named selection and defaults
* [Create the draft](#2-create-the-draft) - what the command writes
* [Give the assistant the brief](#3-give-the-assistant-the-brief) - complete the same package
* [Check the result](#4-check-the-result) - validation, compilation and runtime tests
* [Command reference](#command-reference) - flags and help
* [Advanced](#advanced) - guided setup and ordinary scaffolding
* [Troubleshooting](#troubleshooting) - symptoms, causes and fixes
* [Where to go next](#where-to-go-next)
## Quickstart
Start in your project folder with a saved manifest named `acme-corp`.
If it does not exist, [create and save it first](/reference/cli/manifest#quickstart).
Use a new directory name for the agent.
These are the complete setup commands:
```sh Terminal — project folder theme={null}
unmute skill install
unmute init hotel-agent --manifest acme-corp --draft
```
Then give your coding assistant this brief:
```text Prompt for your coding assistant theme={null}
Use the Unmute skill to complete the existing hotel-agent
draft.
Read hotel-agent/manifest first and preserve it and its
link unchanged.
Build a hotel information assistant that answers questions
about opening hours and amenities. Ask me for the hotel's
facts instead of inventing them.
Choose permitted models and infrastructure. Write the
conversation instructions, then run validation and
compilation and fix any errors.
Tell me what still needs runtime testing.
```
This creates an unfinished package, not a running voice agent. The prompt
asks the coding assistant to edit that package. Do not run `init` again to
complete it.
## 1. Choose the contract
`acme-corp` is the manifest's saved name on this computer. It can differ from
the company name written inside the file.
| Selection | What happens |
| ---------------------- | -------------------------------------------------- |
| `--manifest acme-corp` | Use that saved contract, regardless of the default |
| `--from-manifest` | Open a picker for guided creation |
| Neither flag | Use the saved default, if one exists |
Direct selection does not change the default. A missing or invalid named
manifest stops creation before any package files are written.
A broken default stops creation only when you have not selected a manifest by name.
`--draft` requires both an agent directory and explicit `--manifest`.
It cannot use `--from-manifest`, and it never asks questions through stdin.
## 2. Create the draft
The quickstart command writes six files under `hotel-agent/`:
| File | Starting contents |
| ----------------- | ---------------------------------------------------------------------- |
| `agent.yaml` | Package name, manifest link and a starter agent pointing to its prompt |
| `targets.yaml` | No targets selected |
| `instructions.md` | Starter prompt for the assistant to replace with the use case |
| `.gitignore` | Excludes local credentials and generated output |
| `.env.example` | Empty; no credentials are chosen |
| `manifest` | Exact copy of the selected contract, including comments |
No models or channels are selected. No tools or tracing are added.
The assistant must fill in the required choices before validation can pass.
Commit the finished package and its manifest together. Validation and
compilation read that local copy, so another computer needs no saved manifest.
Editing the saved source later does not update existing packages.
## 3. Give the assistant the brief
The quickstart brief keeps the agent small: hotel facts and no booking system.
The assistant reads the copied manifest before choosing models, targets,
languages, regions, tools or tracing. It then edits the package files.
For SLNG-served models, the provider remains `slng` even when a model ID names
Cartesia or Deepgram. An explicit allowlist limits the IDs the assistant can
choose. **Allow all models** permits any ID from that service; target support
and provider requirements still apply.
The skill explains conflicts instead of loosening the contract.
It should ask for missing business facts or tool interfaces, not invent them.
See [model choices](/models/llm) and [tools](/build/tools/overview) when the
brief needs more than the native workflow.
If you already created `my-new-agent`, use its name in the quickstart brief.
Skip the `init` command and have the assistant complete those existing files.
## 4. Check the result
After the assistant finishes its edits, these are the complete check commands:
```sh Terminal — project folder theme={null}
unmute validate hotel-agent
unmute compile hotel-agent
```
Fix validation errors in the package. Do not remove a company rule to make an
error disappear. Compilation writes target artifacts under `hotel-agent/build/`;
it does not prove that the conversation works with real providers.
| Target | Next runtime check |
| ------------------ | --------------------------------------------------------------------------------- |
| LiveKit or Pipecat | [Run the browser loop](/dev/overview) with `unmute dev hotel-agent` |
| SLNG | Follow the [deployment workflow](/reference/cli/deploy); SLNG has no `unmute dev` |
Phone calls require a deployed agent and a real carrier. See the
[telephony guide](/telephony/overview) when your brief needs phone access.
## Command reference
```text Terminal — unmute init --help theme={null}
$ unmute init --help
Scaffold a new v1 agent package.
Usage:
unmute init [name] [flags]
Flags:
--draft Write an unfinished package without prompts (requires name and --manifest).
--from-manifest Choose a saved organization manifest.
-h, --help help for init
--manifest string Use a saved organization manifest by name.
```
The agent name is also its directory. An occupied directory is refused.
Plain `init` without a name asks for one in a terminal; outside a terminal,
you must supply the name.
## Advanced
### Use guided setup instead
For a fresh package, this complete command selects the same contract and opens
the interactive agent setup:
```sh Terminal — alternative to the draft workflow theme={null}
unmute init guided-hotel-agent --manifest acme-corp
```
Guided setup collects choices and checks the package before saving.
The manifest picker is an alternative to named selection, not a name-taking flag:
```sh Terminal — choose a saved contract interactively theme={null}
unmute init another-hotel-agent --from-manifest
```
The creation console cannot collect custom model endpoints or SLNG Context
Router upstream settings. Use the draft workflow for those bindings, then
follow the relevant [model reference](/models/llm).
### Start without a company contract
When no saved default exists, `unmute init ` writes the ordinary scaffold.
It selects LiveKit, SLNG speech models, an OpenAI reasoning model, a browser
channel and an `end_call` tool. With a default present, it opens guided setup
under that contract instead.
The scaffold's `.env.example` lists starter environment names. After compiling,
`build//.env.example` lists the values needed by that target.
Follow [credentials](/reference/secrets) and [targets](/targets/overview) to finish setup.
### Refresh the assistant's instructions
After updating the CLI, run `unmute skill install` again in the project folder.
The skill ships in the binary. Review local edits before replacing them with
`--force`; see [skill installation](/reference/cli/skill).
## Troubleshooting
| Symptom | Cause | Fix |
| -------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
| `accepts at most 1 arg(s), received 2` | An older binary treats the word after `--from-manifest` as another agent argument | Update the binary and use `--manifest acme-corp` |
| Creation opens a TUI | `--draft` was omitted | Add `--draft` for coding-assistant setup without prompts |
| `validate: no targets selected` | The draft is still incomplete | Have the assistant finish models, targets and channels, then validate again |
| Creation reports a missing manifest | The name is not saved on this computer | Use the correct saved name or create it with `unmute manifest create` |
| The assistant tries to weaken a rule | The brief conflicts with the contract | Change the agent design or ask the contract owner to resolve the conflict |
| The destination is not empty | The package already exists | Complete those files, or choose a fresh directory |
| The assistant does not know `--draft` | Its installed skill is older than the CLI | Update the CLI and rerun `unmute skill install` |
## Where to go next
Understand the contract the assistant must preserve.
Install the workflow your coding assistant follows.
Read and fix errors before compilation.
Add tasks or handoffs when the use case needs them.