> ## Documentation Index
> Fetch the complete documentation index at: https://docs.envlink.projectinwork.com/llms.txt
> Use this file to discover all available pages before exploring further.

# sandbox

> Make this machine the sandbox your environments are wired to.

## envctl sandbox up

```bash theme={null}
envctl sandbox up [--name <name>] [--home <folder>]
```

Registers this machine with the API as your organization's sandbox, starts envd in the background, and joins your organization's tailnet. Environments you create from here on are wired to it: their services listen on this machine's `localhost`, and their shares sync with this folder.

| Flag | Default | Description |
| - | - | - |
| `--name` | the hostname | This machine's name on the tailnet |
| `--home` | the current folder | The folder relative share paths start from |
| `--config`, `--key` | | Run envd from a given configuration and single-use key instead of asking the API; for tests |

If envd is already running, it says so and stops; run `envctl sandbox down` first to start over somewhere else. `env create` and `env delete` rewire the running envd for you.

## envctl sandbox down

```bash theme={null}
envctl sandbox down [--forget]
```

Stops envd. Its tailnet identity is kept, so `sandbox up` later is quick. `--forget` also deregisters this machine, takes it off the tailnet and deletes its identity. Use it on CI runners and machines you're retiring.

## envctl sandbox status

```bash theme={null}
envctl sandbox status
```

The same as `envctl status`, for the sandbox's envd: its name, the services it imports, its shares with their last generation, and the peers it can see.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.