Promptless

https://promptless.ai/docs
Admin
Promptless is an AI documentation agent that automatically detects product changes, drafts updates...
Tokens:216,613
Snippets:1,817
Trust Score:7
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### Manually start enrollment with promptless-host-runtime enroll

Source: https://promptless.ai/docs/governance/get-started/enroll-your-hosts

Use this command to start enrollment manually when needed. Substitute the absolute path to the installed pig plugin directory. Use --host codex for Codex, --host claude for Claude Code, or --host claude-desktop for Claude Desktop.

```bash
PIG_PLUGIN_ROOT="/absolute/path/to/installed/pig"
python3 "$PIG_PLUGIN_ROOT/runtime/promptless-host-runtime" enroll --host codex
```

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

### Content update feedback examples

Source: https://promptless.ai/docs/for-docs/work-the-queue/reviewing-prs

Examples of requests for adding or modifying documentation content.

```txt
Please add a section about error handling for this API endpoint
```

```txt
This example should use TypeScript instead of JavaScript
```

```txt
Add a note that this feature requires admin permissions
```

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

### Clone release branch and install Gemini CLI extensions

Source: https://promptless.ai/docs/governance/get-started/publish-and-install-plugins

Clones the release branch of the instruction hub and installs the pig, docs, and dev extensions into the Gemini CLI. Installing from a local directory copies the extension into Gemini's installation; keeping the clone current alone does not update the installed extension. Restart Gemini CLI after installation.

```bash
git clone --branch release/stable --single-branch \
  https://github.com/acme/acme-instruction-hub.git acme-instruction-hub-release
gemini extensions install ./acme-instruction-hub-release/dist/gemini/pig
gemini extensions install ./acme-instruction-hub-release/dist/gemini/docs
gemini extensions install ./acme-instruction-hub-release/dist/gemini/dev
gemini extensions list
```

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

### Style and formatting feedback examples

Source: https://promptless.ai/docs/for-docs/work-the-queue/reviewing-prs

Examples of requests for improving the visual presentation and readability of documentation.

```txt
Format this as a code block instead of inline code
```

```txt
Add syntax highlighting for the JSON examples
```

```txt
Use a callout box to highlight this important warning
```

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

### Get task status response example

Source: https://promptless.ai/docs/for-docs/connect/triggers/api

Example response from the Get task status endpoint. Poll this endpoint on an interval until `finished` is `true`, back off and retry on a `503`, and deduplicate messages by their stable `id`.

```json
{
  "trigger_event_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "in_progress",
  "finished": false,
  "submitted_at": "2026-08-20T14:32:00Z",
  "source": "api",
  "request": "Document the new rate limiting feature added in v2.5",
  "resolution": null,
  "outcome": null,
  "suggestions": [
    {
      "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "title": "Document the new rate limiting feature",
      "description": "Add a rate limiting section to the API guide.",
      "status": "open",
      "doc_collection_id": "3f2504e0-4f89-41d3-9a0c-0305e82c3301",
      "docs_pr_url": "https://github.com/acme/docs/pull/482",
      "branch_name": "promptless/document-rate-limits",
      "labels": ["documentation"],
      "assignees": ["deploy-bot@acme.com"],
      "created_at": "2026-08-20T14:35:00Z"
    }
  ],
  "status_guidance": "Keep polling until finished is true.",
  "messages": [
    {
      "id": "b1e2c3d4-5678-90ab-cdef-1234567890ab",
      "trigger_event_id": "550e8400-e29b-41d4-a716-446655440000",
      "sequence": 1,
      "author": { "type": "customer", "name": "deploy-bot@acme.com" },
      "created_at": "2026-08-20T14:32:05Z",
      "message": "Document the new rate limiting feature added in v2.5"
    }
  ]
}
```

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

### 200 response example for Get account details

Source: https://promptless.ai/docs/for-docs/api/operations/getaccount

Example 200 response body for the Get account details endpoint. Contains the organization ID and display name; org_name is null for organizations created before names were recorded.

```json
{
  "org_id": "org_2b5f9c1e",
  "org_name": "Acme, Inc."
}
```

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

### Verify collection with ensure and status commands

Source: https://promptless.ai/docs/governance/get-started/enroll-your-hosts

After manual enrollment, start a new session to let the startup hook fetch the host's configuration. You can also request initialization explicitly with ensure and check status with status.

```bash
python3 "$PIG_PLUGIN_ROOT/runtime/promptless-host-runtime" ensure --host codex
python3 "$PIG_PLUGIN_ROOT/runtime/promptless-host-runtime" status --host codex
```

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

### Get account details with Fetch and cURL

Source: https://promptless.ai/docs/for-docs/api/operations/getaccount

Retrieve the organization associated with your API key. The Fetch example uses async/await and logs the response or error; the cURL example sends a GET request with a bearer token. Replace <token> with your actual API key.

```javascript
const url = 'https://api.gopromptless.ai/v1/account';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};


try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```bash
curl --request GET \
  --url https://api.gopromptless.ai/v1/account \
  --header 'Authorization: Bearer <token>'
```

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

### Create the repository with pig init

Source: https://promptless.ai/docs/governance/get-started/set-up-your-instruction-hub

Creates the repository directory, initializes a Git repository, and runs pig init to scaffold the hub. The command writes hub.yaml, creates plugins/pig.yaml, and prepares the asset directories. Keep the pig plugin: the toolchain requires that literal ID and adds the hub's update skill to its Claude and Codex versions.

```bash
mkdir acme-instruction-hub
cd acme-instruction-hub
git init -b main
pig init --hub . --org Acme \
  --marketplace-id acme-instruction-hub \
  --marketplace-name "Acme Instruction Hub" \
  --version 0.1.0
```

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

### Install PIG supervisor chart

Source: https://promptless.ai/docs/governance/deploy-the-worker/deploy-the-analyzer-worker

Installs the PIG supervisor chart into the pig-system namespace with a 10-minute timeout. The supervisor waits for a PIGDeployment before starting release transitions.

```bash
helm install pig-supervisor "./pig-supervisor-${PIG_CHART_VERSION}.tgz" \
  --namespace pig-system --values supervisor-values.yaml \
  --wait --timeout 10m
```

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

### Capture multiple screens for a flow

Source: https://promptless.ai/docs/for-docs/work-the-queue/reviewing-from-slack-and-teams

Use this example to request screenshots of multiple screens from staging for a new onboarding flow.

```txt
@Promptless we need screenshots of the new onboarding flow. Please capture the welcome screen, the team setup page, and the final confirmation from staging.
```

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

### Example instructions for channel mentions

Source: https://promptless.ai/docs/for-docs/work-the-queue/reviewing-from-slack-and-teams

These are example messages to tag Promptless in a channel to trigger documentation updates. Each message includes specific instructions for the type of update desired.

```txt
@Promptless please also add a troubleshooting section covering the error cases we discussed earlier in this thread
```

```txt
@Promptless make sure to mention that this feature is only available in the Enterprise plan
```

```txt
@Promptless create a mermaid chart for the system architecture discussed in this thread
```

```txt
@Promptless capture a screenshot of the new export dialog from our staging environment and add it to the export feature docs
```

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

### 401 error response example for Get account details

Source: https://promptless.ai/docs/for-docs/api/operations/getaccount

Example 401 error response body. Indicates the API key is missing, invalid, or revoked. The error field is a stable machine-readable code and message is a human-readable explanation.

```json
{
  "error": "authentication_failed",
  "message": "Authentication failed."
}
```

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

### Example configuration YAML

Source: https://promptless.ai/docs/for-docs/reference/configuration-reference

Example configuration showing doc_collections, context_sources, triggers, and policies. Built-in triggers are always on and not configured here. Validation errors include unknown keys, invalid enums, missing required fields, duplicate repository keys, malformed doc_collections keys, and provider-backed trigger changes while disconnected.

```yaml
doc_collections:
  acme/documentation:
    docs_framework: docusaurus
    docs_root_url: https://docs.acme.com
    config_file_path: docusaurus.config.js
    filter:
      - docs/

context_sources:
  jira:
    source_type: jira
    project_keys:
      - DOCS
      - ENG
  linear:
    source_type: linear
    team_keys:
      - engineering

# Built-in triggers (api, github_mention, jira_mention, msteams_mention, slack_mention, web)
# are always on for connected integrations and are not configured here;
# their keys remain valid in policies rules.
triggers:
  main-repos:
    trigger_type: github_pr
    match:
      - repos:
          - acme/backend
          - acme/frontend
        trigger_on:
          - opened
          - first_approval
        trigger_directories:
          - src/

  support-channel:
    trigger_type: slack_listen
    match:
      - channels:
          - customer-support

policies:
  default:
    notification:
      slack_channel: docs-updates
    publishing:
      auto_create_pr: true
      auto_merge: false

  rules:
    - if:
        trigger: slack_mention
      then:
        publishing:
          suppress_source_pr_comments: true
```

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

### Use design specs from a PDF attachment

Source: https://promptless.ai/docs/for-docs/work-the-queue/reviewing-from-slack-and-teams

Use this example to provide a design spec (PDF attached) and request documentation that matches the described flow.

```txt
@Promptless here's the design spec for the new onboarding flow (PDF attached). Please create documentation that matches this flow.
```

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

### Fetch GET /v1/triggers/{trigger_event_id}

Source: https://promptless.ai/docs/for-docs/api/operations/gettaskstatus

JavaScript example using fetch to call the endpoint. Requires a bearer token in the Authorization header. Logs the response data or error.

```JavaScript
const url = 'https://api.gopromptless.ai/v1/triggers/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};


try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

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

### Review-bot setup with `updated`

Source: https://promptless.ai/docs/for-docs/connect/triggers/github-prs

Review-bot setup with `updated`. The clause must have an explicit `repos` list and is scoped with `trigger_directories` to run the review-bot cadence on its own.

```yaml
triggers:
  docs-review-bot:
    trigger_type: github_pr
    match:
      - repos:
          - acme/docs
        trigger_on:
          - updated          # Re-review on each new push
        trigger_directories:
          - docs/
```

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

### Install or upgrade the worker with Helm

Source: https://promptless.ai/docs/governance/deploy-the-worker/manual-helm

Installs or upgrades the pig-trace-analyzer release in the pig namespace using the values file, waiting up to 20 minutes. A pre-install or pre-upgrade Job applies database schema changes before the new worker starts. Back up your database before upgrading because a failed release does not undo schema changes.

```bash
helm upgrade --install pig-trace-analyzer ./pig-trace-analyzer \
  --namespace pig \
  --values values.yaml \
  --wait --timeout 20m
```

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

### Install the pig toolchain

Source: https://promptless.ai/docs/governance/get-started/set-up-your-instruction-hub

Creates a virtual environment, installs the pig toolchain from its public Git repository, and verifies the installation with pig --help. These are macOS/Linux shell commands; on Windows, activate the environment with its Scripts/Activate.ps1 script. Activate this environment again when you return to authoring.

```bash
python3 -m venv ~/.venvs/pig
source ~/.venvs/pig/bin/activate
python -m pip install "git+https://github.com/Promptless/pig-toolchain.git@main"
pig --help
```
Tokens:
Raw