> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nanoclaw.dev/llms.txt
> Use this file to discover all available pages before exploring further.
# Getting started with a template
> Choose a prebuilt assistant, connect it to a conversation, and give it its first task — with clear setup and success checks.
A **template** gives your assistant a starting set of instructions and tools for a particular job. You choose what you need help with, then tell the assistant about your own situation.
This guide creates a new assistant from a template and helps you reach it for a first conversation. Allow time for downloads and account sign-ins; the total varies with your computer and the template's requirements.
Already running NanoClaw? Use [Using a template](/templates/using-templates) to add one to your existing installation. For a general assistant without a template, use the [quickstart](/quickstart).
## Pick what you want first
Choose a starting point that matches your goal. These are examples from the [template library](https://github.com/nanocoai/nanoclaw-templates):
A family assistant for meal planning and household routines. Look for `lifestyle/family-assistant` in the library.
A starting point for competitor research. Look for `product/competitor-analysis`.
An assistant for prospect research and CRM work. Look for `sales/sdr`.
Open the template's page before choosing it. Read its description and account requirements. **Some templates need paid services or access to accounts you already use.** For example, the sales template uses HubSpot and Exa. Check that those requirements suit you before installing.
The library also includes data-analysis and journalism templates. You can choose any listed template; the setup steps below are the same.
## Before you start
* Use a **Mac or Linux computer with at least 4 GB of memory**, an internet connection, and permission to install software. On Windows, first follow [Microsoft's WSL setup guide](https://learn.microsoft.com/en-us/windows/wsl/install), then work inside the Linux app it installs.
* Have your **AI account sign-in** ready. Setup offers Claude, including subscription sign-in or an Anthropic API key, and Codex with its own sign-in options. The [quickstart's account guidance](/quickstart#before-you-start) explains the choices.
* Keep the computer on and connected when you want your assistant to respond.
If you choose the prebuilt sandbox download, setup also asks you to sign in to **NanoClaw**. That is separate from your AI account. Choosing **Build it here** skips the download-account step.
On Linux, use a regular user account. If you're installing on a server, read the [installation requirements](/installation#requirements), including the Google Cloud caveat, first.
## The full flow
Terminal is the app where you enter the installation commands. On a Mac, press **Command + Space**, type **Terminal**, and press **Return**. On Linux, open **Terminal** from your applications. On Windows with WSL, open your Linux app, such as **Ubuntu**.
Git downloads NanoClaw. Check whether it's installed by entering:
```bash theme={null}
git --version
```
**You should see:** a line beginning with `git version`. If your Mac offers to install developer tools, follow that prompt and try again. If Git is missing, follow the [Git installation instructions](https://git-scm.com/install/) before continuing.
Run these commands **one line at a time** in Terminal. Press **Enter** after each line and wait for it to finish before running the next.
```bash theme={null}
cd ~
git clone https://github.com/nanocoai/nanoclaw.git
cd nanoclaw
bash nanoclaw.sh
```
The first line opens your home folder. The next two download NanoClaw into `nanoclaw` and open that folder. The last line starts setup. If that folder already exists, use [the existing-install guidance](/templates/using-templates) instead of deleting it.
Choose **Standard setup**. Use the arrow keys to move through options and **Enter** to select one.
At **How should we create your first agent?**, choose **From the NanoClaw template library**. Select the template you chose above. The short identifier beside its name helps you recognize it.
**You should see:** the library selection finish and setup continue. The assistant is created later in the process, after the AI account and timezone steps.
Choose **From local templates** to select one in this installation's `templates/` folder. **Fresh agent** creates a general assistant without a template.
At the sandbox choice, **Fetch the hardened image, built by Echo** downloads the prepared software and opens a NanoClaw sign-in. **Build it here** prepares the software locally instead. Choose the local build if you plan to use Codex; the prebuilt image supports Claude.
Leave Terminal open while the download or local build finishes. Setup then installs **OneCLI**, the vault that stores account credentials.
Choose your AI option and follow its sign-in prompts. For a Claude subscription, select **Claude**, then **Claude subscription**. This connects the AI account, not the NanoClaw download account. See [the illustrated sign-in walkthrough](/quickstart#prepare-workspace) if you need help recognizing the browser steps.
Let setup finish the access rules and background service. Enter your name when asked. It sends a test message to check the AI connection.
At **What next?**, choose **Continue with setup** for this walkthrough. The temporary test assistant is not your template assistant. Follow the timezone prompt if one appears.
**You should see:** a message beginning **Template agent** and ending **created**, with the new assistant's name. Keep that name handy for the connection step.
Choose how you want to reach this assistant. Setup calls the connection a **channel**.
Select your app at the channel question and follow its prompts. Each app has its own account or bot requirements; the [channel guides](/channels/overview) cover those steps.
**Check the final instructions in Terminal.** If setup tells you to check the app for a welcome message, open that conversation and reply.
If it says **one DM to go**, send the bot a direct message in that app first. Then follow setup's instruction to run **/init-first-agent** in your coding assistant and select the person to connect. When it asks which assistant to use, choose the **existing template assistant** whose name matches the earlier creation message. For example, in Claude Code, enter `claude` in Terminal, then enter `/init-first-agent` in Claude Code. This finishes the connection; see [Microsoft Teams](/channels/teams) for that flow.
**You should see:** a reply from the assistant in the conversation you connected. A finished download or successful AI test alone does not confirm this connection.
Choose **Skip for now** at the channel question and let setup finish. The template assistant still needs a terminal connection.
From the `nanoclaw` folder, list your assistants:
```bash theme={null}
ncl groups list
```
Find the entry whose `name` matches the template assistant named by setup. Copy its `id`. Replace `` below with that value, including removing the angle brackets:
```bash theme={null}
ncl wirings create --channel-type cli --platform-id local --agent-group-id
```
This connects terminal messages to that assistant. For this new-install path, you chose **Continue with setup**, so you did not create a separate terminal assistant during the earlier test.
**If you already created or connected another terminal assistant**, inspect `ncl wirings list` before adding a connection. More than one assistant can answer the same terminal message. Use the [CLI channel guide](/channels/cli) to check the existing connections.
Send your template assistant a message:
```bash theme={null}
pnpm run chat "Hi! What do you need from me to get started?"
```
**You should see:** its reply printed in Terminal. The command sends one message; run it again with new text for another turn. If it does not reply, check the connection rather than creating another assistant.
Start with something from the template's description. Tell the assistant enough about your situation to make its answer useful. For example, a family assistant needs to know who a meal plan is for; a competitor-research assistant needs the companies you want to follow.
You can begin with:
> What do you need from me to get started, and which accounts should I connect?
Answer its questions. If it needs another service, follow that service's connection instructions. If it provides an account-connection link, open the link to connect the account. See [Credentials](/operate/credentials) for help; do not paste keys into the conversation.
**You should see:** a response relevant to the job you selected, or a specific request for information or access needed to continue. A template supplies a starting point, not your private account details.
Some templates include routines such as a morning briefing or weekly review. They start **paused**. You can leave them paused while you get to know the assistant.
To enable one, open Terminal in your `nanoclaw` folder. Run `ncl groups list` and copy the `id` for your template assistant if you do not already have it.
Replace `` with that ID to list only this assistant's paused routines:
```bash theme={null}
ncl tasks list --group --status paused
```
If none are listed, there is no paused routine to enable. Otherwise, copy the full value under **SERIES** for the routine you want. Use it in place of `` to inspect the task:
```bash theme={null}
ncl tasks get --id --group
```
Check the task's instructions, schedule, and required account connections. When you want that recurring work to begin, enable it:
```bash theme={null}
ncl tasks resume --id --group
```
**Check the result:** run the `get` command again. The task should now be **pending**, which means it is enabled for its schedule; it does not mean it has already run. See [Scheduled tasks](/guides/scheduled-tasks) for delivery and monitoring.
## You're set. What now?
Give the assistant a small task and refine the result together. Keep its routines paused until their instructions and account connections are ready.
Adjust the instructions and preferences that shape how your assistant works.
Understand what an update replaces and what it preserves before applying one.
## If something went wrong
| What you see | What to do next |
| - | - |
| No welcome message | Follow setup's final connection instructions. Some apps need your first direct message before the connection can finish. |
| No reply in Terminal | Check that the selected template assistant has a CLI connection in `ncl wirings list`; skipping the channel step does not add one. |
| `ncl` or `pnpm` is not found after setup | Open a new Terminal window, run `cd ~/nanoclaw`, and retry. On Windows, reopen your Linux app. If that fails, use [Troubleshooting](/operate/troubleshooting). |
| A service returns `401` or `403` | Check its account connection and permissions using [Credentials](/operate/credentials). These errors do not always mean the same thing. |
| A routine never runs | Check its status and schedule. Template routines begin paused; follow [the routine steps](#enable-routines) above. |
| Setup stops partway | Run `bash nanoclaw.sh` again from the same folder. If asked, choose **Keep it & continue setup**. |
| You're asked to add or update a template | This is the existing-install flow. **No template changes** is the default; see [Using a template](/templates/using-templates) for create, connect, and update choices. |
If you need help, ask in [Discord](https://discord.gg/VDdww8qS42) with the step name and error message. Leave out passwords, account keys, and sign-in codes.
## Related pages
* [Template overview](/templates/overview): what a template contains.
* [Using a template](/templates/using-templates): add another assistant or work with an existing installation.
* [Building a template](/templates/building): create a template of your own.
* [Quickstart](/quickstart): set up a general assistant without a template.
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.