跳到主要内容
    ↑↓ 选择↵ 打开esc 关闭
    中文English
    meimingqi222

    Redact

    v1.0.4认证与凭证
    opencode-redact

    OpenCode plugin that automatically redacts API keys, tokens, passwords and other secrets from all data sent to LLMs

    GitHub 星标

    0

    月装机量

    60

    近 7 天 11

    综合评分SCORE

    26.7

    生态多维模型

    最近提交

    2 个月前

    2026-05-28

    快速安装与配置

    opencode.json

    写入当前项目的 opencode.json,只对这个仓库生效。

    opencode.json

    {
      "$schema": "https://opencode.ai/config.json",
      "plugin": ["opencode-redact@1.0.4"]
    }

    opencode 启动时会通过内嵌运行时自动加载 npm 依赖并缓存至本地目录,无需手动在全局环境执行安装。

    Automatically redact API keys, tokens, passwords and secrets from all data sent to LLMs — before they leave your machine.

    npm license

    OpenCode plugin with 112 built-in detection rules covering GitHub PAT, AWS keys, OpenAI/Anthropic API keys, Stripe tokens, JWT, Slack webhooks, private keys, and more.

    Quick Start

    npx opencode-redact install
    

    That's it. The CLI updates your opencode.json and package.json, then runs bun install to fetch the plugin. Restart OpenCode and all your secrets are protected.

    Uninstall any time:

    npx opencode-redact uninstall
    

    Manual install

    Add to opencode.json:

    { "plugin": ["opencode-redact"] }
    

    Then add the dependency and install:

    cd ~/.config/opencode
    echo '{"dependencies":{"opencode-redact":"^1.0.0"}}' >> package.json
    bun install
    

    Features

    • Zero config — works out of the box with 112 built-in patterns
    • Automatic detection — keyword pre-filter + regex matching, catches secrets you forgot about
    • Invisible Unicode stripping — removes Unicode Tags block characters (anti-prompt-injection)
    • Deep traversal — recursively scans objects, arrays, preserves image/base64 data
    • Path-based redaction — optional: redact specific fields like token, credentials.password

    Hooks

    The plugin intercepts data at every stage before it reaches the LLM:

    User message  →  [chat.message]  →  redacted
    Tool call     →  [tool.execute.before]  →  args redacted
    Tool result   →  [tool.execute.after]  →  output redacted
    Full history  →  [experimental.chat.messages.transform]  →  all messages redacted
    

    Covered Secrets

    Category Examples
    Git hosting GitHub (PAT/OAuth/App/Fine-grained), GitLab, Bitbucket, Sourcegraph
    Cloud AWS (Access + Secret Key), GCP Service Account, Cloudflare, Heroku, Alibaba
    AI/LLM OpenAI (4 variants), Anthropic
    Collaboration Slack (6), Discord (3), LinkedIn, Twitch, Twitter, Facebook
    Payments Stripe, Flutterwave
    Infrastructure Docker config, JWT, npm, PyPI, Rubygems, Pulumi, Age, SendGrid
    Monitoring Grafana, New Relic, Databricks, Dynatrace
    Other HubSpot, Intercom, Mailchimp, Mailgun, Typeform, Todoist, Canva
    Generic api-key, webhook-secret, password, sk-secret, private keys

    See patterns.ts for the full list.

    Configuration

    // opencode.json
    {
      "plugin": [
        [
          "opencode-redact",
          {
            "disabled": false,         // set true to disable
            "extraPatterns": [],        // custom secret patterns
            "redactPaths": [],          // path-based redaction: ["token", "user.password"]
            "pathCensor": "[REDACTED]"  // censor text for path redaction
          }
        ]
      ]
    }
    

    Custom patterns

    {
      "extraPatterns": [
        {
          "id": "my-company-key",
          "category": "custom",
          "title": "My Company API Key",
          "pattern": "(mykey-[a-z0-9]{32})",
          "keywords": ["mykey-"]
        }
      ]
    }
    

    CLI

    npx opencode-redact install              # one-command setup
    npx opencode-redact uninstall            # remove
    npx opencode-redact status               # check
    npx opencode-redact install --local ./   # from local clone
    

    License

    MIT

    Links