### Example: Fully Populated Work Item

Source: https://github.com/makeplane/docs/blob/master/docs/core-concepts/issues/work-item-url.md

Create a work item with all common fields pre-filled, including title, description, project, priority, assignees, start date, and due date.

```bash
https://app.plane.so/work-items/new?title=Implement+dark+mode&description=Add+dark+mode+support+to+the+dashboard&project=FRONTEND&priority=medium&assignee=me,john&start_date=2024-03-15&due_date=2024-03-30
```

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

### Detailed Bug Creation Command Example

Source: https://github.com/makeplane/docs/blob/master/docs/ai/pi-chat.md

This example demonstrates how to provide specific details for creating a bug report, including priority, issue, assignee, and sprint.

```text
create a high-priority bug for the payment gateway timeout, assign to backend team, and add to Sprint 24
```

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

### Install Project Dependencies

Source: https://github.com/makeplane/docs/blob/master/README.md

Install all necessary project dependencies using pnpm.

```bash
pnpm install
```

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

### Start Local Dev Server

Source: https://github.com/makeplane/docs/blob/master/AGENTS.md

Use this command to start the local development server for VitePress.

```bash
pnpm dev            # Start local dev server (http://localhost:5173)
```

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

### Start Local Development Server

Source: https://github.com/makeplane/docs/blob/master/README.md

Run this command to start a local development server for Plane. Changes are reflected live without server restarts.

```bash
pnpm dev
```

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

### Domain Restriction Configuration Example

Source: https://github.com/makeplane/docs/blob/master/docs/automations/plane-runner.md

Shows how to configure the 'allowed_domains' list for external HTTP requests. Requests to domains not in this list will fail.

```javascript
Plane.script.allowed_domains = ["api.example.com", "*.google.com"];

fetch('https://api.example.com/data'); // Allowed
fetch('https://untrusted.com/data'); // Throws 'Domain not allowed' error
```

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

### Example PR Title and Description for State Automation

Source: https://github.com/makeplane/docs/blob/master/docs/integrations/github.md

This example shows how to format a GitHub Pull Request title and description to trigger state automation for one work item and only link another.

```bash
PR Title: [WEB-344] Add user authentication feature
PR Description: Implements login functionality for WEB-345
```

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

### Example: Bug Report with Title and Description

Source: https://github.com/makeplane/docs/blob/master/docs/core-concepts/issues/work-item-url.md

Create a work item with a pre-filled title and description, demonstrating URL parameter usage for bug reporting.

```bash
https://app.plane.so/work-items/new?title=Login+button+not+working&description=Users+cannot+click+the+login+button+on+mobile
```

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

### Scheduled Trigger Example

Source: https://github.com/makeplane/docs/blob/master/docs/automations/custom-automations.md

This is an example of a comment template that can be used with the 'Add comment' action. It demonstrates how to include dynamic values like current priority and state using template variables.

```text
This item has been moved to a new state. Current priority: {{priority}}. Please check if the due date needs updating.
```

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

### Example: High-Priority Task Assigned to Self

Source: https://github.com/makeplane/docs/blob/master/docs/core-concepts/issues/work-item-url.md

Create a high-priority task assigned to the current user, specifying the project and title.

```bash
https://app.plane.so/work-items/new?project=WEB&priority=high&assignee=me&title=Fix+authentication+bug
```

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

### Example of Runner-Specific Globals

Source: https://github.com/makeplane/docs/blob/master/docs/automations/plane-runner.md

Illustrates the usage of Plane-specific global objects like Plane, Functions, ENV, and fetch within the automation script.

```javascript
const workspace = Plane.getWorkspace();
console.log(`Running in workspace: ${workspaceSlug}`);
const envVar = ENV.MY_VARIABLE;
fetch('https://example.com');
```

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

### Example of Allowed JavaScript Globals

Source: https://github.com/makeplane/docs/blob/master/docs/automations/plane-runner.md

Demonstrates the use of standard JavaScript globals available within the Plane runner sandbox, such as JSON, Math, and Date.

```javascript
const now = new Date();
const formattedDate = JSON.stringify(now);
console.log(formattedDate);
```

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

### Navigate to Project Directory

Source: https://github.com/makeplane/docs/blob/master/README.md

Change the current directory to the cloned Plane documentation project.

```bash
cd docs
```

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

### VitePress Front Matter Example

Source: https://github.com/makeplane/docs/blob/master/AGENTS.md

Example of a front matter block required for VitePress Markdown files. Includes title and description for SEO.

```yaml
---
title: Page Title
description: One-sentence summary (used for SEO meta and og:description)
---
```

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

### CSV File Format Example

Source: https://github.com/makeplane/docs/blob/master/docs/importers/csv.md

This is an example of the expected CSV format for importing work items. Ensure your file adheres to these columns and data types.

```csv
name,description_html,priority,start_date,target_date,state_group
Quarterly report,<p>Compile Q2 results for stakeholder review.</p>,high,2025-04-01,2025-04-10,started
Update vendor contracts,,medium,2025-04-05,2025-04-20,unstarted
Office supply restock,,low,,,backlog
```

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

### Set Work Item Start Date via URL

Source: https://github.com/makeplane/docs/blob/master/docs/core-concepts/issues/work-item-url.md

Set the start date for a work item using the 'start_date' query parameter. Accepts 'YYYY-MM-DD' or ISO 8601 formats.

```bash
https://app.plane.so/work-items/new?start_date=2024-03-15
```

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

### Build Static Files for Production

Source: https://github.com/makeplane/docs/blob/master/README.md

Generate static files for deployment into the `docs/.vitepress/dist` directory.

```bash
pnpm build
```

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

### Build a URL with Parameters

Source: https://github.com/makeplane/docs/blob/master/docs/core-concepts/issues/work-item-url.md

Construct a URL to create a new work item, pre-filling fields with query parameters. Use '+' or '%20' for spaces and '&' to separate multiple parameters.

```bash
https://app.plane.so/work-items/new?title=Fix+bug&priority=high&assignee=me
```

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

### Checkout Preview Branch

Source: https://github.com/makeplane/docs/blob/master/CONTRIBUTING.md

Use this command to switch to the preview branch before making changes.

```bash
git checkout preview
```

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

### Example CSV for importing members

Source: https://github.com/makeplane/docs/blob/master/docs/core-concepts/workspaces/members.md

This CSV format is required for bulk importing members into a workspace. Ensure the columns are in the exact order specified.

```csv
Email,Display Name,First Name,Last Name,Role
alex@company.com,Alex Chen,Alex,Chen,member
sarah@company.com,Sarah Kim,Sarah,Kim,admin
mike@company.com,Mike Rodriguez,Mike,Rodriguez,guest
```

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

### Preview Production Build

Source: https://github.com/makeplane/docs/blob/master/AGENTS.md

Command to preview the production build of the VitePress site locally.

```bash
pnpm preview        # Preview the production build locally
```

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

### Make HTTP Requests with Fetch

Source: https://github.com/makeplane/docs/blob/master/docs/automations/plane-runner.md

Demonstrates how to use the sandboxed `fetch` function to make HTTP requests to allowed domains. It supports standard Fetch API options for methods, headers, and bodies, and can utilize environment variables for authentication.

```typescript
const response = await fetch("https://api.example.com/data", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    Authorization: `Bearer ${ENV.API_TOKEN}`,
  },
  body: JSON.stringify({ key: "value" }),
});

const data = await response.json();
```

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

### Insert Draw.io Whiteboard

Source: https://github.com/makeplane/docs/blob/master/docs/core-concepts/pages/editor-blocks.md

Use the /board or /drawio-board slash command to insert a Draw.io whiteboard block. Click the placeholder to launch the board interface.

```bash
/board
/drawio-board
```