Factory

https://docs.factory.ai/
Admin
Factory is a platform that leverages AI agents (Droids) and a customizable interface to help...
Tokens:290,029
Snippets:2,808
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install Dependencies and Run Setup

Source: https://docs.factory.ai/web/machine-connection/cloud-templates

Standard commands for installing project dependencies and executing the setup script within the build container.

```bash
npm ci

pip install -r requirements.txt

bash ./scripts/setup.sh
```

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

### Run AutoWiki Install Command

Source: https://docs.factory.ai/cli/features/wiki/auto-refresh

Execute the /install-wiki command to initiate the CI workflow setup.

```bash
> /install-wiki
```

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

### Phase 1 Prompt: Authentication Migration Setup

Source: https://docs.factory.ai/cli/user-guides/implementing-large-features

Use this prompt to guide the implementation of the first phase of a migration, focusing on initial setup without impacting existing functionality.

```text
I'm implementing Phase 1 of the authentication migration plan documented in
IMPLEMENTATION_PLAN.md.

Phase 1 focuses on setting up Auth0 configuration and creating the basic
authentication service without affecting existing Firebase integration.

Please read the plan document and implement this phase, then update the
document to mark Phase 1 as complete.
```

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

### Install QA Skill

Source: https://docs.factory.ai/guides/skills/automated-qa

Run the one-time setup skill to analyze your codebase and generate a tailored QA skill for your project.

```bash
droid
> /install-qa
```

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

### Multi-language Project Setup Script

Source: https://docs.factory.ai/web/machine-connection/cloud-templates/index

Setup script for projects with multiple languages (Node.js and Python). Installs dependencies for both and executes a local setup script. Includes strict error handling.

```bash
#!/usr/bin/env bash
set -euo pipefail

# Install Node.js dependencies
npm ci

# Install Python dependencies
pip install -r requirements.txt

# Run setup script
bash ./scripts/setup.sh
```

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

### Clone and Run the Official Droid Exec Example

Source: https://docs.factory.ai/guides/building/droid-exec-tutorial

Clones the Factory AI examples repository, navigates to the droid-chat directory, installs dependencies, and starts the development server. Access the chat interface at http://localhost:4000.

```bash
git clone https://github.com/Factory-AI/examples.git
cd examples/droid-chat
bun i
bun dev
```

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

### Node.js Setup Script

Source: https://docs.factory.ai/web/machine-connection/cloud-templates/index

Setup script for Node.js (Next.js) projects. Installs dependencies and builds the project. Ensure strict error handling with 'set -euo pipefail'.

```bash
#!/usr/bin/env bash
set -euo pipefail

npm ci
npm run build
```

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

### Install and Build Project

Source: https://docs.factory.ai/web/machine-connection/cloud-templates/index

Use this command to install project dependencies and build the project. It's recommended to run package installation first.

```bash
npm ci && npm run build
```

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

### Initialize Code Review via CLI

Source: https://docs.factory.ai/cli/features/install-github-app

Use this command in the Droid CLI to start the guided setup flow for automated code review.

```bash
droid
> /install-code-review
```

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

### Set up Nginx with Docker using Droid

Source: https://docs.factory.ai/guides/building/droid-vps-setup

Use Droid to automate the setup of Nginx with Docker, including serving a 'Hello World' page. Droid handles Docker installation, configuration, file creation, container setup, and networking.

```bash
# In your VPS, with droid running
> Set up Nginx with Docker and serve a hello world page
```

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

### Install and Test Plugin

Source: https://docs.factory.ai/guides/building/building-plugins

Commands to add a local plugin to the marketplace and install it for testing.

```bash
droid plugin marketplace add ./my-plugin
droid plugin install my-plugin@my-plugin
```

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

### Add and Install a Marketplace Plugin

Source: https://docs.factory.ai/guides/building/building-plugins

CLI commands to register a local marketplace and install a plugin from it.

```bash
droid plugin marketplace add ./your-org-plugins
droid plugin install pr-triage@your-org-plugins
```

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

### Install Bun and Droid CLI, then Sign In

Source: https://docs.factory.ai/guides/building/droid-exec-tutorial

Installs the Bun JavaScript runtime, the Droid CLI, and authenticates your session with Factory. This is a one-time setup for using `droid exec` without API keys in code.

```bash
# Install Bun
curl -fsSL https://bun.sh/install | bash

# Install the Droid CLI
curl -fsSL https://app.factory.ai/cli | sh

# Sign in to Factory (one-time browser auth)
droid
```

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

### Install Documentation Tools (Go)

Source: https://docs.factory.ai/guides/hooks/documentation-sync

Install documentation tools for Go projects, including godoc and swag for Swagger.

```bash
go install golang.org/x/tools/cmd/godoc@latest
go install github.com/swaggo/swag/cmd/swag@latest  # For Swagger
```

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

### Install Testing Frameworks (Go)

Source: https://docs.factory.ai/guides/hooks/testing-automation

Go has built-in testing capabilities. For enhanced output, install gotestsum.

```bash
# go test is built-in
go install github.com/gotestyourself/gotestsum@latest  # Better test output
```

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

### Install a plugin via CLI

Source: https://docs.factory.ai/cli/configuration/plugins

Installs a plugin from a marketplace with a specified scope.

```bash
droid plugin install droid-control@factory-plugins --scope project
```

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

### POST /api/v0/computers/{computerId}/install-deps

Source: https://docs.factory.ai/api-reference/computers/retry-the-install-dependencies-step

Starts a new dependency-installation attempt on a managed computer. Returns 202 Accepted if successful, or 409 Conflict if an installation is already in progress.

```APIDOC
## POST /api/v0/computers/{computerId}/install-deps

### Description
Starts a new dependency-installation attempt on a managed computer that was configured to install dependencies. Installation runs in the background.

### Method
POST

### Endpoint
/api/v0/computers/{computerId}/install-deps

### Parameters
#### Path Parameters
- **computerId** (string) - Required - Computer ID

### Response
#### Success Response (202)
- **id** (string) - Computer ID
- **hostId** (string) - Host ID (UUID)
- **name** (string) - Computer name
- **providerType** (string) - Compute provider backing this computer
- **status** (string) - Current status (provisioning, active, error)
- **createdAt** (number) - Creation timestamp
- **provisioningSteps** (array) - List of provisioning steps
- **relayClientUrl** (string) - Relay client URL
- **relayAgentUrl** (string) - Relay agent URL
- **remoteUser** (string) - Remote user
- **clonedRepoDirectories** (array) - List of cloned repository directories
- **ownerPrincipalKind** (string) - Owner principal kind
- **ownerId** (string) - Owner ID
- **computerSource** (object) - Source configuration of the computer
```

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

### Check Go installation

Source: https://docs.factory.ai/guides/hooks/auto-formatting

Verify that gofmt is installed as part of the Go installation.

```bash
go version
```

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

### Connect to VPS and Install Droid CLI

Source: https://docs.factory.ai/guides/building/droid-vps-setup

Connect to your VPS using the configured SSH alias and then install the Droid CLI on the server using a curl command. Source the appropriate file to activate the installation.

```bash
ssh example

curl -fsSL https://app.factory.ai/cli | sh

source ~/.bashrc  # or source ~/.zshrc if using zsh

droid --version
```

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

### Provide output examples

Source: https://docs.factory.ai/guides/power-user/prompt-crafting

Define expected output formats by providing input-output pairs within an example block.

```text
<example>
Input: "user not found"
Output: { code: "USER_NOT_FOUND", message: "The specified user does not exist", httpStatus: 404 }
</example>

Now handle these error cases following the same pattern:
- Invalid password
- Account locked
- Session expired
```

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

### Install Dependencies

Source: https://docs.factory.ai/guides/skills/vibe-coding

Installs all necessary project dependencies using npm.

```bash
npm install
```

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

### Install Notification Tools (Linux)

Source: https://docs.factory.ai/guides/hooks/notifications

Install the `libnotify-bin` package for Linux systems to enable desktop notifications.

```bash
# Install notify-send
sudo apt-get install libnotify-bin  # Ubuntu/Debian
sudo dnf install libnotify           # Fedora
sudo pacman -S libnotify             # Arch
```

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

### Install Droid plugins

Source: https://docs.factory.ai/reference/cli-reference

Command to install plugins with a specific scope.

```bash
droid plugin install factory/code-review --scope project
```

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

### Install Specific Plugins

Source: https://docs.factory.ai/cli/configuration/plugins

Installs individual plugins from the registered marketplace by specifying the plugin name and source.

```bash
droid plugin install droid-control@factory-plugins
droid plugin install droid-evolved@factory-plugins
droid plugin install security-engineer@factory-plugins
```

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

### Download and Verify Linux Binary

Source: https://docs.factory.ai/reference/cli-reference

Example script to download, verify, and set permissions for a specific Linux binary.

```bash
VERSION=0.174.0
BASE_URL="https://downloads.factory.ai/factory-cli/releases/${VERSION}/linux/x64"

curl -fsSLO "${BASE_URL}/droid"
curl -fsSLO "${BASE_URL}/droid.sha256"
echo "$(awk '{print $1}' droid.sha256)  droid" | sha256sum --check
chmod +x droid
```

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

### Install Documentation Tools (Python)

Source: https://docs.factory.ai/guides/hooks/documentation-sync

Install essential documentation tools for Python projects using pip.

```bash
pip install sphinx pdoc3 mkdocs
pip install pydoc-markdown  # Markdown docs from docstrings
```

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

### SessionStart Hook Configuration

Source: https://docs.factory.ai/reference/hooks-reference

JSON structure for loading context at the start of a session.

```json
{
  "hookSpecificOutput": {
    "hookEventName": "SessionStart",
    "additionalContext": "My additional context here"
  }
}
```

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

### SessionStart Hook Input

Source: https://docs.factory.ai/reference/hooks-reference

Input schema for session start events.

```json
{
  "session_id": "abc123",
  "transcript_path": "~/.factory/projects/.../00893aaf-19fa-41d2-8238-13269b9b3ca0.jsonl",
  "cwd": "/Users/...",
  "permission_mode": "off",
  "hook_event_name": "SessionStart",
  "source": "startup"
}
```

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

### Debug Output Example

Source: https://docs.factory.ai/reference/hooks-reference

Example of the output generated when running Droid with the --debug flag to monitor hook execution.

```text
[DEBUG] Executing hooks for PostToolUse:Create
[DEBUG] Getting matching hook commands for PostToolUse with query: Create
[DEBUG] Found 1 hook matchers in settings
[DEBUG] Matched 1 hooks for query "Create"
[DEBUG] Found 1 hook commands to execute
[DEBUG] Executing hook command: <Your command> with timeout 60000ms
[DEBUG] Hook command completed with status 0: <Your stdout>
```

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

### Implement Robust Setup Script Practices

Source: https://docs.factory.ai/web/machine-connection/cloud-templates

Recommended commands and patterns to ensure setup scripts are reliable, reproducible, and handle errors correctly.

```bash
npm ci && npm run build
```

```bash
pip install -r requirements.txt && pytest -q
```

```bash
#!/usr/bin/env bash
set -euo pipefail
```

```bash
chmod +x ./scripts/setup.sh && bash ./scripts/setup.sh
```

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

### Hook configuration without matchers

Source: https://docs.factory.ai/reference/hooks-reference

Example of configuring hooks for events that do not require a matcher, such as UserPromptSubmit.

```json
{
  "hooks": {
    "UserPromptSubmit": [
      {
        "hooks": [
          {
            "type": "command",
            "command": "/path/to/prompt-validator.py"
          }
        ]
      }
    ]
  }
}
```

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

### Git Worktree CLI Commands

Source: https://docs.factory.ai/reference/cli-reference

Examples of using the --worktree flag for interactive and headless Droid sessions.

```bash
# Interactive: derive branch from current branch (creates <current>-wt)
droid --worktree

# Interactive: explicit branch name
droid -w fix-auth-bug "start debugging the login flow"

# Headless: isolate an automated task on its own branch
droid exec --worktree refactor-tests --auto medium "migrate jest suites to vitest"

# Run two parallel sessions on the same repo, each on its own branch
droid --worktree feature-a &
droid --worktree feature-b &
```

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

### Configure Hooks for MCP Tools

Source: https://docs.factory.ai/reference/hooks-reference

A JSON configuration example demonstrating how to use regex matchers to target specific MCP tools or entire MCP servers.

```json
{
  "hooks": {
    "PreToolUse": [
      {
        "matcher": "mcp__memory__.*",
        "hooks": [
          {
            "type": "command",
            "command": "echo 'Memory operation initiated' >> ~/mcp-operations.log"
          }
        ]
      },
      {
        "matcher": "mcp__.*__write.*",
        "hooks": [
          {
            "type": "command",
            "command": "/home/user/scripts/validate-mcp-write.py"
          }
        ]
      }
    ]
  }
}
```

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

### Integrate Droid into CI/CD pipelines

Source: https://docs.factory.ai/reference/cli-reference

Example configuration for running Droid analysis within a GitHub Actions workflow.

```yaml
# GitHub Actions example
- name: Run Droid Analysis
  env:
    FACTORY_API_KEY: ${{ secrets.FACTORY_API_KEY }}
  run: |
    droid exec --auto medium -f .github/prompts/deploy.md
```

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

### UserPromptSubmit Context and Validation Example

Source: https://docs.factory.ai/reference/hooks-reference

Python script demonstrating security filtering and context injection for user prompts.

```python
#!/usr/bin/env python3
import json
import sys
import re
import datetime

# Load input from stdin
try:
    input_data = json.load(sys.stdin)
except json.JSONDecodeError as e:
    print(f"Error: Invalid JSON input: {e}", file=sys.stderr)
    sys.exit(1)

prompt = input_data.get("prompt", "")

# Check for sensitive patterns
sensitive_patterns = [
    (r"(?i)\b(password|secret|key|token)\s*[:=]", "Prompt contains potential secrets"),
]

for pattern, message in sensitive_patterns:
    if re.search(pattern, prompt):
        # Use JSON output to block with a specific reason
        output = {
            "decision": "block",
            "reason": f"Security policy violation: {message}. Please rephrase your request without sensitive information."
        }
        print(json.dumps(output))
        sys.exit(0)

# Add current time to context
context = f"Current time: {datetime.datetime.now()}"
print(context)

"""
The following is also equivalent:
print(json.dumps({
  "hookSpecificOutput": {
    "hookEventName": "UserPromptSubmit",
    "additionalContext": context,
  },
}))
"""

# Allow the prompt to proceed with the additional context
sys.exit(0)
```

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

### Python Setup Script

Source: https://docs.factory.ai/web/machine-connection/cloud-templates/index

Setup script for Python projects. Installs dependencies from requirements.txt and runs pytest quietly. Uses strict error handling.

```bash
#!/usr/bin/env bash
set -euo pipefail

pip install -r requirements.txt
pytest -q
```

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

### Run Setup Script Directly

Source: https://docs.factory.ai/web/machine-connection/cloud-templates/index

Use this command to directly run the setup script. It's an alternative to making it executable first.

```bash
bash ./scripts/setup.sh
```

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

### Install Specific Droid Version via npm

Source: https://docs.factory.ai/reference/cli-reference

Pin a specific version of the Droid CLI when using npm.

```bash
npm install -g droid@0.174.0
```

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

### PNPM Monorepo Setup Script

Source: https://docs.factory.ai/web/machine-connection/cloud-templates/index

Setup script for PNPM monorepos. Installs and builds dependencies across workspaces. Includes strict error handling.

```bash
#!/usr/bin/env bash
set -euo pipefail

pnpm -w i
pnpm -w build
```

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

### Org-managed hooks configuration

Source: https://docs.factory.ai/reference/hooks-reference

Example of enterprise-level settings enforcing managed hooks and restricting execution to managed hooks only.

```json
{
  "allowManagedHooksOnly": true,
  "hooks": {
    "PreToolUse": [
      {
        "matcher": "Execute",
        "hooks": [
          {
            "type": "command",
            "command": "/usr/local/bin/audit-command.sh",
            "timeout": 30
          }
        ]
      }
    ]
  }
}
```

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

### Run Go Documentation Server

Source: https://docs.factory.ai/guides/hooks/documentation-sync

This command starts a local HTTP server to serve Go documentation, accessible at http://localhost:6060.

```bash
godoc -http=:6060
```

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

### Execute Command Validation Example

Source: https://docs.factory.ai/reference/hooks-reference

Python script to validate shell commands and block execution using exit code 2.

```python
#!/usr/bin/env python3
import json
import re
import sys

# Define validation rules as a list of (regex pattern, message) tuples
VALIDATION_RULES = [
    (
        r"\bgrep\b(?!.*\|)",
        "Use 'rg' (ripgrep) instead of 'grep' for better performance and features",
    ),
    (
        r"\bfind\s+\S+\s+-name\b",
        "Use 'rg --files | rg pattern' or 'rg --files -g pattern' instead of 'find -name' for better performance",
    ),
]


def validate_command(command: str) -> list[str]:
    issues = []
    for pattern, message in VALIDATION_RULES:
        if re.search(pattern, command):
            issues.append(message)
    return issues


try:
    input_data = json.load(sys.stdin)
except json.JSONDecodeError as e:
    print(f"Error: Invalid JSON input: {e}", file=sys.stderr)
    sys.exit(1)

tool_name = input_data.get("tool_name", "")
tool_input = input_data.get("tool_input", {})
command = tool_input.get("command", "")

if tool_name != "Execute" or not command:
    sys.exit(1)

# Validate the command
issues = validate_command(command)

if issues:
    for message in issues:
        print(f"• {message}", file=sys.stderr)
    # Exit code 2 blocks tool call and shows stderr to Droid
    sys.exit(2)
```

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

### Initialize Remotion Dependencies

Source: https://docs.factory.ai/cli/features/droid-control

Run these commands to locate the plugin path and install required dependencies for video rendering.

```bash
droid plugin list --scope user
cd <plugin-path>/remotion && npm install
```

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

### Understand Project Structure

Source: https://docs.factory.ai/cli/getting-started/quickstart

Query Droid about entry points and testing setup in your project.

```bash
> where are the main entry points and how is testing set up?
```

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

### Disable Auto-updates

Source: https://docs.factory.ai/reference/cli-reference

Prevents the Droid CLI from automatically checking for and installing updates by setting an environment variable.

```bash
export FACTORY_DROID_AUTO_UPDATE_ENABLED=false
```

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

### List CI Repository Owners API Requests

Source: https://docs.factory.ai/api-reference/automations/list-ci-repository-owners

Examples of how to perform a GET request to the repository owners endpoint across different languages.

```bash
curl --request GET \
  --url https://api.factory.ai/api/v0/automations/ci/repository-owners \
  --header 'Authorization: Bearer <token>'
```

```python
import requests  
  
url = "https://api.factory.ai/api/v0/automations/ci/repository-owners"  
  
headers = {"Authorization": "Bearer <token>"}  
  
response = requests.get(url, headers=headers)  
  
print(response.text)
```

```javascript
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};  
  
fetch('https://api.factory.ai/api/v0/automations/ci/repository-owners', options)  
  .then(res => res.json())  
  .then(res => console.log(res))  
  .catch(err => console.error(err));
```

```php
<?php  
  
$curl = curl_init();  
  
curl_setopt_array($curl, [  
  CURLOPT_URL => "https://api.factory.ai/api/v0/automations/ci/repository-owners",  
  CURLOPT_RETURNTRANSFER => true,  
  CURLOPT_ENCODING => "",  
  CURLOPT_MAXREDIRS => 10,  
  CURLOPT_TIMEOUT => 30,  
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,  
  CURLOPT_CUSTOMREQUEST => "GET",  
  CURLOPT_HTTPHEADER => [  
    "Authorization: Bearer <token>"  
  ],  
]);  
  
$response = curl_exec($curl);  
$err = curl_error($curl);  
  
curl_close($curl);  
  
if ($err) {  
  echo "cURL Error #:" . $err;  
} else {  
  echo $response;  
}
```

```go
package main  
  
import (  
	"fmt"  
	"net/http"  
	"io"  
)  
  
func main() {  
  
	url := "https://api.factory.ai/api/v0/automations/ci/repository-owners"  
  
	req, _ := http.NewRequest("GET", url, nil)  
  
	req.Header.Add("Authorization", "Bearer <token>")  
  
	res, _ := http.DefaultClient.Do(req)  
  
	defer res.Body.Close()  
	body, _ := io.ReadAll(res.Body)  
  
	fmt.Println(string(body))  
  
}
```

```java
HttpResponse<String> response = Unirest.get("https://api.factory.ai/api/v0/automations/ci/repository-owners")  
  .header("Authorization", "Bearer <token>")  
  .asString();
```

```ruby
require 'uri'  
require 'net/http'  
  
url = URI("https://api.factory.ai/api/v0/automations/ci/repository-owners")  
  
http = Net::HTTP.new(url.host, url.port)  
http.use_ssl = true  
  
request = Net::HTTP::Get.new(url)  
request["Authorization"] = 'Bearer <token>'  
  
response = http.request(request)  
puts response.read_body
```

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

### Make Setup Script Executable

Source: https://docs.factory.ai/web/machine-connection/cloud-templates/index

This command makes the setup script executable and then runs it. It helps avoid permission errors mid-build.

```bash
chmod +x ./scripts/setup.sh && bash ./scripts/setup.sh
```

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

### Analyze Codebase Architecture

Source: https://docs.factory.ai/cli/getting-started/common-use-cases

Use this prompt to get a high-level understanding of a project's architecture, technologies, frameworks, entry points, and testing setup.

```text
Analyze this codebase and explain the overall architecture.
What technologies and frameworks does this project use?
Where are the main entry points and how is testing set up?
```

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

### Define Setup Scripts for Cloud Templates

Source: https://docs.factory.ai/web/machine-connection/cloud-templates

Shell scripts executed during template initialization to install dependencies and prepare the environment. Ensure scripts are non-interactive and idempotent.

```bash
#!/usr/bin/env bash
set -euo pipefail

npm ci
npm run build
```

```bash
#!/usr/bin/env bash
set -euo pipefail

pnpm -w i
pnpm -w build
```

```bash
#!/usr/bin/env bash
set -euo pipefail

pip install -r requirements.txt
pytest -q
```

```bash
#!/usr/bin/env bash
set -euo pipefail
```

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

### Example Factory App configuration

Source: https://docs.factory.ai/cli/configuration/settings

A sample JSON configuration file demonstrating model selection, reasoning effort, and sound settings.

```json
{
  "model": "claude-opus-4-7",
  "reasoningEffort": "low",
  "diffMode": "github",
  "cloudSessionSync": true,
  "completionSound": "fx-ok01",
  "awaitingInputSound": "fx-ack01",
  "soundFocusMode": "always"
}
```

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

### Directory Structure for Rules

Source: https://docs.factory.ai/guides/power-user/rules-conventions

Organize project rules into a layered directory structure for clarity and maintainability. This example shows a typical setup for different rule categories.

```bash
.factory/rules/
├── _base/                    # Foundation rules (everyone follows)
│   ├── typescript.md
│   └── security.md
├── frontend/                 # Frontend-specific
│   ├── react.md
│   └── styling.md
├── backend/                  # Backend-specific
│   ├── api.md
│   └── database.md
└── testing/                  # Testing standards
├── unit.md
└── integration.md
```

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

### Full sandbox configuration reference

Source: https://docs.factory.ai/cli/configuration/sandbox

Comprehensive configuration example defining isolation mode, filesystem access rules, and allowed network domains.

```jsonc
{
  "sandbox": {
    "enabled": true,
    // Isolation scope: "per-command" (default) or "whole-process"
    "mode": "per-command",
    "filesystem": {
      // Additional writable paths beyond CWD (which is always writable)
      "allowWrite": ["/tmp/build-output", "~/.config"],
      // Deny writes to specific subpaths even if parent is in allowWrite
      "denyWrite": ["/tmp/build-output/cache/locks", "~/.config/secrets"],
      // Block reads to specific paths (everything else is readable)
      "denyRead": ["~/.aws/credentials", "~/.ssh/id_rsa"]
    },
    "network": {
      // Only these domains are reachable (Factory's own domains always included)
      "allowedDomains": ["github.com", "*.npmjs.org"]
    }
  }
}
```

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

### Create a computer using cURL

Source: https://docs.factory.ai/api-reference/computers/create-a-computer

Command-line example for creating a computer resource.

```bash
curl --request POST \
  --url https://api.factory.ai/api/v0/computers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "provider": "byom",
  "hostId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "remoteUser": "<string>",
  "repos": [
    "<string>"
  ],
  "autoInstallDeps": true,
  "serviceAccountId": "<string>",
  "source": {
    "kind": "template",
    "templateId": "<string>"
  }
}
'
```

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

### List Service Account API Keys API Requests

Source: https://docs.factory.ai/api-reference/service-accounts/list-service-account-api-keys

Examples of how to perform a GET request to retrieve API keys for a service account using different programming languages.

```curl
curl --request GET \
  --url https://api.factory.ai/api/v0/service-accounts/{serviceAccountId}/api-keys \
  --header 'Authorization: Bearer <token>'
```

```python
import requests  
  
url = "https://api.factory.ai/api/v0/service-accounts/{serviceAccountId}/api-keys"  
  
headers = {"Authorization": "Bearer <token>"}  
  
response = requests.get(url, headers=headers)  
  
print(response.text)
```

```javascript
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};  
  
fetch('https://api.factory.ai/api/v0/service-accounts/{serviceAccountId}/api-keys', options)  
  .then(res => res.json())  
  .then(res => console.log(res))  
  .catch(err => console.error(err));
```

```php
<?php  
  
$curl = curl_init();  
  
curl_setopt_array($curl, [  
  CURLOPT_URL => "https://api.factory.ai/api/v0/service-accounts/{serviceAccountId}/api-keys",  
  CURLOPT_RETURNTRANSFER => true,  
  CURLOPT_ENCODING => "",  
  CURLOPT_MAXREDIRS => 10,  
  CURLOPT_TIMEOUT => 30,  
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,  
  CURLOPT_CUSTOMREQUEST => "GET",  
  CURLOPT_HTTPHEADER => [  
    "Authorization: Bearer <token>"  
  ],  
]);  
  
$response = curl_exec($curl);  
$err = curl_error($curl);  
  
curl_close($curl);  
  
if ($err) {  
  echo "cURL Error #:" . $err;  
} else {  
  echo $response;  
}
```

```go
package main  
  
import (  
	"fmt"  
	"net/http"  
	"io"  
)  
  
func main() {  
  
	url := "https://api.factory.ai/api/v0/service-accounts/{serviceAccountId}/api-keys"  
  
	req, _ := http.NewRequest("GET", url, nil)  
  
	req.Header.Add("Authorization", "Bearer <token>")  
  
	res, _ := http.DefaultClient.Do(req)  
  
	defer res.Body.Close()  
	body, _ := io.ReadAll(res.Body)  
  
	fmt.Println(string(body))  
  
}
```

```java
HttpResponse<String> response = Unirest.get("https://api.factory.ai/api/v0/service-accounts/{serviceAccountId}/api-keys")  
  .header("Authorization", "Bearer <token>")  
  .asString();
```

```ruby
require 'uri'  
require 'net/http'  
  
url = URI("https://api.factory.ai/api/v0/service-accounts/{serviceAccountId}/api-keys")  
  
http = Net::HTTP.new(url.host, url.port)  
http.use_ssl = true  
  
request = Net::HTTP::Get.new(url)  
request["Authorization"] = 'Bearer <token>'  
  
response = http.request(request)  
puts response.read_body
```

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

### Make setup-env script executable

Source: https://docs.factory.ai/guides/hooks/session-automation

Grant execute permissions to the setup-env.sh script to allow it to be run.

```bash
chmod +x .factory/hooks/setup-env.sh
```

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

### Example Action Items Output

Source: https://docs.factory.ai/cli/features/readiness-report

The report concludes with 2-3 highest-impact recommendations to reach the next maturity level. These action items guide the user on the most effective steps for improvement.

```text
Action Items:
- Add pre-commit hooks with husky to enforce linting and formatting
- Configure branch protection rules on the main branch
- Add AGENTS.md with setup and development instructions
```

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

### Example Middleware Configuration

Source: https://docs.factory.ai/guides/droid-exec/refactor-fix-lint

This snippet shows how to configure middleware with options like required role, CSRF validation, and context for error logging. It's used within the Droid Exec prompt to guide the refactoring process.

```javascript
    // Existing route logic here
    return NextResponse.json({ data });
  },
  { requiredRole: AdminRole.ADMIN_1 }
);

```
Tokens:
Raw