Mastra Factory

https://factory.mastra.ai/
Admin
Mastra Factory is an open-source platform for building software with coding agents that connects to...
Tokens:33,880
Snippets:289
Trust Score:9.4
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Start development server with npm

Source: https://factory.mastra.ai/reference/create-factory

Use npm to start the development server for the default template. Run from the generated directory.

```bash
cd my-mastra-factory
npm run dev
```

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

### Setup command for repository sandbox

Source: https://factory.mastra.ai/configure/sandboxes

Set this command in Settings → Repositories under Sandbox to install dependencies and generate files before the agent runs. It runs when the sandbox first starts and is skipped on warm restarts if successful.

```bash
pnpm i && pnpm build
```

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

### Start development server with Bun

Source: https://factory.mastra.ai/reference/create-factory

Use Bun to start the development server for the default template. Run from the generated directory.

```bash
cd my-mastra-factory
bun run dev
```

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

### Create project without platform setup using Bun

Source: https://factory.mastra.ai/reference/create-factory

Skips platform sign-in and resource provisioning with --no-platform using Bun. Still downloads the template and installs dependencies, but copies .env.example to .env without filling in platform credentials.

```bash
bun x create-factory@latest my-mastra-factory --no-platform
```

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

### Run create-factory with Bun

Source: https://factory.mastra.ai/reference/create-factory

Starts the interactive wizard using Bun. By default, dependencies are installed and the project is connected to Mastra platform resources.

```bash
bun x create-factory@latest
```

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

### Install dependencies and build Factory Server (Bun)

Source: https://factory.mastra.ai/deployment

Run these commands from the Factory Server directory to install dependencies and build the server. The build writes the server and Factory UI to .mastra/output.

```bash
npm ci --include dev
# couldn't auto-convert command
bun run check
bun run build
```

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

### Run create-factory with npm

Source: https://factory.mastra.ai/reference/create-factory

Starts the interactive wizard using npm. By default, dependencies are installed and the project is connected to Mastra platform resources.

```bash
npx create-factory@latest
```

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

### Install dependencies and build Factory Server (npm)

Source: https://factory.mastra.ai/deployment

Run these commands from the Factory Server directory to install dependencies and build the server. The build writes the server and Factory UI to .mastra/output.

```bash
npm ci --include=dev
npm run check
npm run build
```

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

### Install dependencies and build Factory Server (pnpm)

Source: https://factory.mastra.ai/deployment

Run these commands from the Factory Server directory to install dependencies and build the server. The build writes the server and Factory UI to .mastra/output.

```bash
npm ci --include=dev
# couldn't auto-convert command
pnpm run check
pnpm run build
```

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

### Run create-factory with pnpm

Source: https://factory.mastra.ai/reference/create-factory

Starts the interactive wizard using pnpm. By default, dependencies are installed and the project is connected to Mastra platform resources.

```bash
pnpm dlx create-factory@latest
```

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

### Start development server with Yarn

Source: https://factory.mastra.ai/reference/create-factory

Use Yarn to start the development server for the default template. Run from the generated directory.

```bash
cd my-mastra-factory
yarn dev
```

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

### Install dependencies and build Factory Server (Yarn)

Source: https://factory.mastra.ai/deployment

Run these commands from the Factory Server directory to install dependencies and build the server. The build writes the server and Factory UI to .mastra/output.

```bash
npm ci --include=dev
# couldn't auto-convert command
yarn run check
yarn build
```

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

### Create project without platform setup using npm

Source: https://factory.mastra.ai/reference/create-factory

Skips platform sign-in and resource provisioning with --no-platform using npm. Still downloads the template and installs dependencies, but copies .env.example to .env without filling in platform credentials.

```bash
npx create-factory@latest my-mastra-factory --no-platform
```

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

### Start development server with pnpm

Source: https://factory.mastra.ai/reference/create-factory

Use pnpm to start the development server for the default template. Run from the generated directory.

```bash
cd my-mastra-factory
pnpm run dev
```

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

### Run create-factory with Yarn

Source: https://factory.mastra.ai/reference/create-factory

Starts the interactive wizard using Yarn. By default, dependencies are installed and the project is connected to Mastra platform resources.

```bash
yarn dlx create-factory@latest
```

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

### Start Factory server with npm, pnpm, Yarn, or Bun

Source: https://factory.mastra.ai/

Start the Factory server using your preferred package manager. The server prints a local Mastra Factory URL to open for sign-in.

```bash
npm run dev
```

```bash
pnpm run dev
```

```bash
yarn dev
```

```bash
bun run dev
```

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

### Create project without platform setup using pnpm

Source: https://factory.mastra.ai/reference/create-factory

Skips platform sign-in and resource provisioning with --no-platform using pnpm. Still downloads the template and installs dependencies, but copies .env.example to .env without filling in platform credentials.

```bash
pnpm dlx create-factory@latest my-mastra-factory --no-platform
```

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

### Create project without platform setup using Yarn

Source: https://factory.mastra.ai/reference/create-factory

Skips platform sign-in and resource provisioning with --no-platform using Yarn. Still downloads the template and installs dependencies, but copies .env.example to .env without filling in platform credentials.

```bash
yarn dlx create-factory@latest my-mastra-factory --no-platform
```

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

### Check Node.js, npm, and Git versions

Source: https://factory.mastra.ai/troubleshooting

Run these commands to verify that Node.js, npm, and Git are installed and meet the version requirements reported by the installer. If any command is missing, install or update the corresponding tool and reopen the terminal before retrying the Factory command.

```bash
node --version
npm --version
git --version
```

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

### Create Factory project with --no-platform flag (Bun)

Source: https://factory.mastra.ai/deployment

Use this command to create a new Factory project without platform credentials. The installer copies .env.example to .env without adding platform credentials, so you must configure authentication, database, and sandbox providers before deployment.

```bash
bunx create-factory my-factory --no-platform
```

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

### Create Factory project with Mastra platform (Bun)

Source: https://factory.mastra.ai/

Run from a directory outside your target repository. The installer signs in to Mastra platform, provisions resources, and writes configuration to .env.

```bash
bunx create-factory my-factory
cd my-factory
```

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

### Create Factory project with --no-platform flag (pnpm)

Source: https://factory.mastra.ai/deployment

Use this command to create a new Factory project without platform credentials. The installer copies .env.example to .env without adding platform credentials, so you must configure authentication, database, and sandbox providers before deployment.

```bash
pnpm create factory my-factory --no-platform
```

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

### MastraFactory Constructor and Lifecycle

Source: https://factory.mastra.ai/reference/mastra-factory-api

Documentation for the MastraFactory constructor and its lifecycle methods (prepare and finalize) as shown in the usage example.

```APIDOC
## MastraFactory Constructor

### Description
Creates a new MastraFactory instance that assembles Factory storage domains, integrations, boards, sessions, and background work into a Mastra application.

### Method
Constructor

### Endpoint
`new MastraFactory(options)`

### Parameters
#### Constructor Options
- **storage** (LibSQLFactoryStorage) - Required - Storage instance for Factory domains.
- **sandbox** (function) - Required - Callback that receives an object with `sessionId` and returns a sandbox instance (e.g., `LocalSandbox`).
- **auth** (object) - Optional - Authentication provider. Defaults to Mastra platform authentication. Must support both Server and Studio authentication.

### Request Example
```typescript
const factory = new MastraFactory({
  storage: new LibSQLFactoryStorage({
    id: 'factory-storage',
    url: 'file:./factory.db',
  }),
  sandbox: ({ sessionId }) =>
    new LocalSandbox({ workingDirectory: join(process.cwd(), 'sandboxes', sessionId) }),
})
```

### Response
Returns a `MastraFactory` instance.

## MastraFactory.prepare()

### Description
Prepares the factory for use, returning a promise that resolves to the assembled Mastra application configuration.

### Method
Async method

### Endpoint
`await factory.prepare()`

### Parameters
None

### Request Example
```typescript
const mastra = new Mastra(await factory.prepare())
```

### Response
Returns a promise that resolves to the prepared Mastra application configuration.

## MastraFactory.finalize()

### Description
Finalizes the factory lifecycle, completing any necessary cleanup or setup after the Mastra application is created.

### Method
Async method

### Endpoint
`await factory.finalize()`

### Parameters
None

### Request Example
```typescript
await factory.finalize()
```

### Response
Returns a promise that resolves when finalization is complete.
```

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

### Create Factory project with --no-platform flag (npm)

Source: https://factory.mastra.ai/deployment

Use this command to create a new Factory project without platform credentials. The installer copies .env.example to .env without adding platform credentials, so you must configure authentication, database, and sandbox providers before deployment.

```bash
npm create factory@latest my-factory -- --no-platform
```

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

### Create Factory project with Mastra platform (npm)

Source: https://factory.mastra.ai/

Run from a directory outside your target repository. The installer signs in to Mastra platform, provisions resources, and writes configuration to .env.

```bash
npm create factory@latest my-factory
cd my-factory
```

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

### Create Factory project with Mastra platform (pnpm)

Source: https://factory.mastra.ai/

Run from a directory outside your target repository. The installer signs in to Mastra platform, provisions resources, and writes configuration to .env.

```bash
pnpm create factory my-factory
cd my-factory
```

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

### Create Factory project with Mastra platform (Yarn)

Source: https://factory.mastra.ai/

Run from a directory outside your target repository. The installer signs in to Mastra platform, provisions resources, and writes configuration to .env.

```bash
yarn create factory my-factory
cd my-factory
```

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

### Install the Mastra Factory skill with npm, pnpm, Yarn, or Bun

Source: https://factory.mastra.ai/skill

Install the Mastra Factory skill using your preferred package manager. During installation, select the target agent and the install scope: the current project or a global install.

```bash
npx skills add mastra-ai/skills --skill mastra-factory
```

```bash
pnpm dlx skills add mastra-ai/skills --skill mastra-factory
```

```bash
yarn dlx skills add mastra-ai/skills --skill mastra-factory
```

```bash
bun x skills add mastra-ai/skills --skill mastra-factory
```

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

### Create project with name using Bun

Source: https://factory.mastra.ai/reference/create-factory

Downloads the Software Factory template and creates a project with the given name using Bun. Prompts for a name if not provided.

```bash
bun x create-factory@latest my-mastra-factory
```

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

### Check and build the server with npm, pnpm, Yarn, or Bun

Source: https://factory.mastra.ai/deployment

Run these commands from the Factory Server directory to check and build the project before deployment. The npm, pnpm, Yarn, and Bun variants are equivalent. Review local environment values so a localhost callback origin isn't used by the deployed server.

```bash
npm run check
npm run build
```

```bash
pnpm run check
pnpm run build
```

```bash
yarn run check
yarn build
```

```bash
bun run check
bun run build
```

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

### Create project with name using pnpm

Source: https://factory.mastra.ai/reference/create-factory

Downloads the Software Factory template and creates a project with the given name using pnpm. Prompts for a name if not provided.

```bash
pnpm dlx create-factory@latest my-mastra-factory
```

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

### finalize() method

Source: https://factory.mastra.ai/reference/mastra-factory-api

Initializes the controller and starts Factory work after the Mastra instance is constructed. Returns a Promise<void>. Calling before preparation throws.

```typescript
await factory.finalize()
```

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

### PlatformSandbox configuration (src/mastra/sandbox.ts)

Source: https://factory.mastra.ai/configure/sandboxes

Selects Mastra platform explicitly. createRepoTemplate uses the session's repository and setup command to prepare a reusable template.

```typescript
import type { MastraFactorySandboxConfig } from '@mastra/factory'
import { PlatformSandbox, createRepoTemplate } from '@mastra/platform-workspace'

export const sandbox: MastraFactorySandboxConfig = ctx =>
	new PlatformSandbox({
		id: ctx.sessionId,
		template: createRepoTemplate(ctx),
	})
```

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

### Create project with name using npm

Source: https://factory.mastra.ai/reference/create-factory

Downloads the Software Factory template and creates a project with the given name using npm. Prompts for a name if not provided.

```bash
npx create-factory@latest my-mastra-factory
```

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

### Create project with name using Yarn

Source: https://factory.mastra.ai/reference/create-factory

Downloads the Software Factory template and creates a project with the given name using Yarn. Prompts for a name if not provided.

```bash
yarn dlx create-factory@latest my-mastra-factory
```
Tokens:
Raw