knock-cli
Audited by Runlayer on Feb 24, 2026
Malicious tool definition detected
Tool: AGENTS.md [1/11] Description: # Knock CLI This skill provides comprehensive guidelines for working with the Knock CLI to manage workflows, templates, and other notification resources. ## How to use this skill When working with this skill, follow these guidelines: 1.
Tool: AGENTS.md [2/11] Description: Push all local resources to Knock: ```bash knock push --all ``` This pushes all resources from the configured `knockDir` to Knock.
Tool: AGENTS.md [3/11] Description: # Push and commit (push does not prompt) knock push --all --commit -m "Updated templates" ``` ## Error handling ### Common errors **"Resource not found"** - The specified key doesn't match any resource - Verify the key matches the directory name exactly **"Validation failed"** - The resource has structural errors - Check the error message for specific field issues - Reference the JSON schema for correct structure - If the error mentions `channel_key` does not
Tool: AGENTS.md [4/11] Description: `values` object must match the fields defined in that variant.
Tool: AGENTS.md [5/11] Description: environment. ## Key gotchas ### Guides are not workflows Do not treat guides like workflows. They have no steps that send notifications, no triggers, and no channel steps.
Tool: AGENTS.md [6/11] Description: {message-type-key}/ │ ├── message_type.json # Schema and metadata │ └── preview.html # Optional; Liquid template for dashboard preview │ ├── translations/ # Translation files │ └── {locale}/ │ └── ...
Tool: AGENTS.md [7/11] Description: the block editor; same format as a message type variant's `fields` | ## input_schema The `input_schema` defines the fields that editors see when adding or editing a partial block in the email visual block editor. It uses the **exact same field format** as a message type variant's `fields` array.
Tool: AGENTS.md [8/11] Description: title | default: "Untitled" }}`. 6.
Tool: AGENTS.md [9/11] Description: | currency }} {% endfor %} ``` ### Default values Always provide defaults for optional values: ```liquid Hi {{ recipient.name | default: "there" }}, ``` ## Step types ### Channel steps (have template content) Channel steps use `"type": "channel"` with a `channel_key` and `channel_type`.
Tool: AGENTS.md [10/11] Description: branches Each branch can optionally terminate the workflow so no subsequent steps run after the branch.
Tool: AGENTS.md [11/11] Description: be blank" or "variant is invalid"** - The `button_set` block requires a `variant` field on each button - Use `solid` or `outline` for the variant value **"must have at least 2 branches"** - The `branches` array in a branch step must contain at least 2 entries - The default branch must be inside the `branches` array with `"default": true`, not as a separate `default_branch` key ## Testing workflows ### Use the CLI to trigger test runs ```bash knock workflow ru
Malicious tool definition detected
Tool: SKILL.md [1/2] Description: --- name: knock-cli description: Guidelines for working with the Knock CLI to manage workflows, templates, and other notification resources in a Knock project. --- # Knock CLI skill This skill provides comprehensive guidelines for working with the Knock CLI to manage workflows, templates, and other notification resources.
Tool: SKILL.md [2/2] Description: type keys ## Best practices summary 1.
Malicious tool definition detected
Tool: rules/cli-commands-reference.md [1/3] Description: --- title: CLI commands reference description: Reference for Knock CLI commands including pull, push, and resource management tags: - knock - cli - commands - pull - push - workflow - resources category: knock-cli last_updated: 2026-02-01 --- # CLI commands reference ## Core concepts ### Interactive prompts and the `--force` flag Many Knock CLI commands display interactive confirmation prompts that require user input.
Tool: rules/cli-commands-reference.md [2/3] Description: knock workflow push --all # Push only email layouts knock email-layout push --all # Push only translations knock translation push --all # Push only guides knock guide push --all # Push only message types knock message-type push --all ``` ### Push a specific resource Push a single resource by its key (the directory name): ```bash # Push a specific workflow knock workflow push <workflow-key> # Push a specific email layout knock email-layout
Tool: rules/cli-commands-reference.md [3/3]
Malicious tool definition detected
Tool: rules/cli-installation-authentication.md Description: --- title: CLI installation and authentication description: How to install the Knock CLI and authenticate using service tokens or dashboard accounts tags: - knock - cli - installation - authentication - service-token - setup category: knock-cli last_updated: 2026-02-01 --- # CLI installation and authentication ## Installation ### Prerequisites The Knock CLI requires Node.js 18+ or can be installed via Homebrew on macOS. ### Installation
Malicious tool definition detected
Tool: rules/guides-and-message-types.md [1/3] Description: --- title: Guides and message types description: Working with Knock Guides for lifecycle messaging and message types as their schema tags: - knock - cli - guides - message-types - in-app - lifecycle - banners - modals category: knock-cli last_updated: 2026-02-16 --- # Guides and message types ## Guides vs workflows **Guides are NOT part of the workflow system.** This is a critical distinction: | Concept | Purpose | Model | |--------|----
Tool: rules/guides-and-message-types.md [2/3] Description: | default: 'free' }} plan." } ``` ## CLI commands ### Guide commands | Command | Description | |---------|-------------| | `knock guide list` | List all guides | | `knock guide get <key>` | Display a single guide | | `knock guide new` | Create a new guide (use `-k`, `-n`, `-m` for key, name, message type) | | `knock guide pull [key]` | Pull guide(s); use `--all` for all | | `knock guide push [key]` | Push guide(s); use `--all` for all |
Tool: rules/guides-and-message-types.md [3/3] Description: Run `knock message-type list`, `knock guide list`, and `knock channel list` before creating 8.
Malicious tool definition detected
Tool: rules/knock-directory-structure.md Description: --- title: Knock directory structure description: Understanding the knock directory layout, configuration files, and resource organization tags: - knock - cli - directory-structure - configuration - knock-json - workflows - layouts category: knock-cli last_updated: 2026-02-16 --- # Knock directory structure ## Project configuration ### The knock.json file Running `knock init` creates a `knock.json` file in your project root.
Malicious tool definition detected
Tool: rules/partials.md [1/2] Description: --- title: Partials description: Reusable template building blocks for email design systems and the visual block editor tags: - knock - cli - partials - email - design-system - visual-blocks - templates category: knock-cli last_updated: 2026-02-16 --- # Partials ## What partials are **Partials** are reusable template snippets that can be inserted into email templates via the visual block editor.
Tool: rules/partials.md [2/2] Description: is added as a visual block in an email template, Knock renders it with the values editors provide in the block editor.
Malicious tool definition detected
Tool: rules/workflow-templates.md [1/4] Description: --- title: Workflow templates description: Patterns, structures, and best practices for working with Knock workflows and templates via the CLI tags: - knock - cli - workflows - templates - email - liquid - gotchas - best-practices category: knock-cli last_updated: 2026-02-16 --- # Workflow templates ## Critical rules ### Always read before writing Before modifying any workflow or template file, always read the existing content first. This prev
Tool: rules/workflow-templates.md [2/4] Description: empty. {% endif %} ``` **Loops:** ```liquid {% for item in data.items %} - {{ item.name }}: {{ item.price | currency }} {% endfor %} ``` ### Default values Always provide defaults for optional values: ```liquid Hi {{ recipient.name | default: "there" }}, ``` ## Step types ### Channel steps (have template content) Channel steps use `"type": "channel"` with a `channel_key` and `channel_type`.
Tool: rules/workflow-templates.md [3/4] Description: Duration object with `unit` and `value` specifying the rolling window length.
Tool: rules/workflow-templates.md [4/4] Description: `method` | HTTP method: `get`, `post`, `put`, `delete`, `patch` | Yes | | `url` | HTTP URL (supports Liquid) | Yes | | `headers` | Array of `{ "key": "...", "value": "..." }` maps | No | | `query_params` | Array of `{ "key": "...", "value": "..." }` maps | No | | `json_body` | JSON request body for POST/PUT (supports Liquid) | No | ### Common mistakes with fetch steps **Wrong type name:** The step type is `http_fetch`, not `fetch`.