### Install and Run Desktop Server Locally

Source: https://github.com/mindsdb/minds/blob/main/README.md

Install the desktop server from the configured branch and then launch the application.

```bash
make server
make app
```

--------------------------------

### Install Dependencies

Source: https://github.com/mindsdb/minds/blob/main/README.md

Install all necessary project dependencies using the provided make command.

```bash
make setup
```

--------------------------------

### Install and Run Desktop Server from Local Uncommitted Source

Source: https://github.com/mindsdb/minds/blob/main/README.md

Install the desktop server directly from your local uncommitted source code and then launch the application.

```bash
make server-local
make app-local
```

--------------------------------

### Wipe Local Installs and Data

Source: https://github.com/mindsdb/minds/blob/main/README.md

Perform a fresh start by removing local runtime components and application data. Use FORCE=1 to skip confirmation.

```bash
make flush
```

--------------------------------

### Install Desktop Server from Branch

Source: https://github.com/mindsdb/minds/blob/main/docs/setup.html

Installs or reinstalls the Electron desktop server from your currently checked-out module branch. This is part of the module-branch development workflow.

```bash
make server
```

--------------------------------

### Start Desktop App with DevTools Enabled

Source: https://github.com/mindsdb/minds/blob/main/docs/setup.html

Starts the desktop application development server with the Electron DevTools automatically opened. Set the ANTON_OPEN_DEVTOOLS environment variable to '1' before running.

```bash
ANTON_OPEN_DEVTOOLS=1 make dev
```

--------------------------------

### Install uv Package Manager

Source: https://github.com/mindsdb/minds/blob/main/docs/setup.html

Installs the 'uv' Python package manager using a curl script. Ensure Node.js, Python 3.12+, and make are installed beforehand.

```bash
curl -LsSf https://astral.sh/uv/install.sh | sh
```

--------------------------------

### Configure Development Environment

Source: https://github.com/mindsdb/minds/blob/main/README.md

Copy the example development environment file and set the REF or API_REF for specific branches.

```bash
cp dev.env.example dev.env      # then set REF=feat/my-thing (or per-module API_REF=…)
```

--------------------------------

### GET /projects

Source: https://github.com/mindsdb/minds/blob/main/docs/api.html

Lists all available projects.

```APIDOC
## GET /projects

### Description
List all projects. Projects are workspaces that group conversations, files, and artifacts.

### Method
GET

### Endpoint
/api/v1/projects

### Response
#### Success Response (200)
Returns a list of project objects.
```

--------------------------------

### Configure Development Environment

Source: https://github.com/mindsdb/minds/blob/main/docs/setup.html

Copies the example development environment file to 'dev.env' and allows setting specific branches for modules. This is the first step in the module-branch workflow.

```bash
cp dev.env.example dev.env
```

--------------------------------

### GET /artifacts/serve/{project_id}/{path}

Source: https://github.com/mindsdb/minds/blob/main/docs/api.html

Serves a raw file content of an artifact.

```APIDOC
## GET /artifacts/serve/{project_id}/{path}

### Description
Serves the raw content of a specific file within an artifact.

### Method
GET

### Endpoint
/api/v1/artifacts/serve/{project_id}/{path}

### Parameters
#### Path Parameters
- **project_id** (string) - Required - The ID of the project.
- **path** (string) - Required - The file path within the artifact (e.g., `index.html` or `assets/chart.js`).
```

--------------------------------

### Build Production Version

Source: https://github.com/mindsdb/minds/blob/main/README.md

Create a production-ready build of the application.

```bash
make build
```

--------------------------------

### Start Docker Stack with API Key

Source: https://github.com/mindsdb/minds/blob/main/docs/setup.html

Starts the MindsDB Docker stack and passes the Anthropic API key inline. This is an alternative to setting the API key in a .env file.

```bash
ANTON_ANTHROPIC_API_KEY=sk-ant-... docker compose up --build
```

--------------------------------

### Package for Windows

Source: https://github.com/mindsdb/minds/blob/main/README.md

Create a distributable package for Windows.

```bash
make dist-win
```

--------------------------------

### Start MindsDB Stack with Docker Compose

Source: https://github.com/mindsdb/minds/blob/main/docs/setup.html

Starts the entire MindsDB stack, including the web SPA served by nginx and the API, using Docker Compose. Ensure Docker images are built first.

```bash
make docker-up
```

--------------------------------

### Show Next Run References

Source: https://github.com/mindsdb/minds/blob/main/README.md

Display the references that the next 'make' command will use.

```bash
make refs
```

--------------------------------

### GET /conversations/{id}

Source: https://github.com/mindsdb/minds/blob/main/docs/api.html

Retrieves a specific conversation by its ID.

```APIDOC
## GET /conversations/{id}

### Description
Get a specific conversation by its ID.

### Method
GET

### Endpoint
/api/v1/conversations/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - Conversation ID.

### Response
#### Success Response (200)
Returns the requested conversation object.
```

--------------------------------

### List All Make Targets

Source: https://github.com/mindsdb/minds/blob/main/docs/setup.html

Displays a list of all available make targets with their descriptions. This is the default goal when running 'make' or 'make help'.

```bash
make help
```

--------------------------------

### GET /artifacts/preview

Source: https://github.com/mindsdb/minds/blob/main/docs/api.html

Previews an artifact by its path and project ID.

```APIDOC
## GET /artifacts/preview

### Description
Provides a preview of an artifact based on its relative path within a project.

### Method
GET

### Endpoint
/api/v1/artifacts/preview

### Parameters
#### Query Parameters
- **path** (string) - Required - The relative path to the artifact (e.g., `sales_dashboard/index.html`).
- **project_id** (string) - Required - The ID of the project that owns the artifact.
```

--------------------------------

### GET /responses/in-flight-list

Source: https://github.com/mindsdb/minds/blob/main/docs/api.html

Lists all currently active AI response streams.

```APIDOC
## GET /responses/in-flight-list

### Description
List active streams.

### Method
GET

### Endpoint
/api/v1/responses/in-flight-list

### Parameters
#### Query Parameters
- **conversation_id** (string) - Optional - Filter to a specific conversation.

### Response
#### Success Response (200)
Returns a list of active in-flight responses.
```

--------------------------------

### Build macOS .app from Local Source

Source: https://github.com/mindsdb/minds/blob/main/README.md

Build the macOS application bundle directly from your local uncommitted source code.

```bash
make pack-local
```

--------------------------------

### GET /schedules

Source: https://github.com/mindsdb/minds/blob/main/docs/api.html

Lists schedules, with optional filtering by project and status.

```APIDOC
## GET /schedules

### Description
Retrieves a list of schedules. You can filter schedules by the project they belong to and their status (`active` or `paused`).

### Method
GET

### Endpoint
/api/v1/schedules

### Parameters
#### Query Parameters
- **project_id** (string) - Optional - Filter schedules belonging to a specific project.
- **status** (string) - Optional - Filter schedules by status (`active` or `paused`).

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the schedule.
- **project_id** (string) - The ID of the project the schedule belongs to.
- **cron** (string) - The cron expression defining the schedule's timing.
- **timezone** (string) - The timezone for the cron expression.
- **prompt** (string) - The task prompt to be executed.
- **conversation_id** (string | null) - The ID of the conversation to append to, or null to create a new one.
- **status** (string) - The current status of the schedule (`active` or `paused`).
- **last_run_at** (string) - The timestamp of the last schedule run.
- **next_run_at** (string) - The timestamp of the next scheduled run.
- **created_at** (string) - The timestamp when the schedule was created.

### Response Example
```json
{
  "id": "sched_abc123",
  "project_id": "proj_xyz",
  "cron": "0 9 * * 1",
  "timezone": "America/New_York",
  "prompt": "Generate weekly sales digest",
  "conversation_id": null,
  "status": "active",
  "last_run_at": "2026-06-09T09:00:00Z",
  "next_run_at": "2026-06-16T09:00:00Z",
  "created_at": "2026-06-01T00:00:00Z"
}
```
```