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

# Workspace yaml

<Note>
  Esta página ainda está em inglês. A tradução para português está em andamento.
</Note>

# workspace.yaml Reference

The `config/workspace.yaml` file is the central configuration for your EvoNexus instance. It's generated by `make setup` and read by the dashboard, scheduler, and setup scripts.

## Location

```
config/workspace.yaml
```

## Format

```yaml theme={null}
name: "My Workspace"
owner: "Your Name"
company: "Your Company"
timezone: "America/Sao_Paulo"
language: "pt-BR"
port: 8080
```

## Fields

### name

**Type:** string
**Required:** yes

Display name for the workspace. Shown in the dashboard header and reports.

### owner

**Type:** string
**Required:** yes

Your name. Used in CLAUDE.md generation and report attribution.

### company

**Type:** string
**Required:** yes

Company name. Used in report headers and financial context.

### timezone

**Type:** string (IANA timezone)
**Required:** yes
**Default:** `America/Sao_Paulo`

Controls schedule timing for all routines. The scheduler uses this to determine when to run morning briefings, end-of-day reports, etc. Must be a valid [IANA timezone identifier](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).

Common values:

* `America/New_York` — US Eastern
* `America/Chicago` — US Central
* `America/Los_Angeles` — US Pacific
* `America/Sao_Paulo` — Brazil (BRT)
* `Europe/London` — UK
* `Europe/Berlin` — Central Europe
* `Asia/Tokyo` — Japan

### language

**Type:** string (language code)
**Required:** yes
**Default:** `pt-BR`

Language for agent responses and generated reports. Agents use this to determine output language.

Common values:

* `pt-BR` — Brazilian Portuguese
* `en` — English
* `es` — Spanish

### port

**Type:** integer
**Required:** yes
**Default:** `8080`

Port for the web dashboard. The Flask backend and React frontend are served on this port.

```bash theme={null}
# Dashboard will be available at:
http://localhost:{port}
```

## How It's Used

| Component | Reads | Uses |
| - | - | - |
| `make setup` | Generates the file | Interactive wizard |
| Dashboard backend | `port` | Server binding |
| Dashboard frontend | `name`, `owner` | UI display |
| Scheduler | `timezone` | Routine scheduling |
| setup.py (CLAUDE.md generation) | All fields | Context generation |

## Editing

You can edit the file directly:

```bash theme={null}
nano config/workspace.yaml
```

Or re-run the setup wizard to regenerate it:

```bash theme={null}
make setup
```

Changes to `port` require restarting the dashboard (`make dashboard-app`). Changes to `timezone` require restarting the scheduler (`make scheduler`).

## Companion Files

The setup wizard also generates these alongside `workspace.yaml`:

| File | Purpose |
| - | - |
| `config/routines.yaml` | Routine schedules and enabled/disabled state |
| `.env` | API keys for integrations |
| `CLAUDE.md` | Context file for Claude Code sessions |


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