docker run -v `pwd`:`pwd` -w `pwd` --rm -it secretlint/secretlint secretlint "**/*"

npx @secretlint/quick-start "**/*"

docker run -v `pwd`:`pwd` -w `pwd` --rm -it secretlint/secretlint secretlint "**/*"

يجب عليك بعد ذلك إعداد ملف تكوين:```
npx secretlint --init

:memo: يدعم Secretlint [نمط glob](https://github.com/mrmlnc/fast-glob#basic-syntax) ويجب أن يُلف نمط glob بين علامتي اقتباس مزدوجتين.

من الممكن أيضًا تثبيت Secretlint عالميًا باستخدام `npm install --global`. لكننا لا نوصي بذلك، فقد تتعطل بعض القواعد عالميًا.

### استخدام الملف الثنائي القابل للتنفيذ المفرد

**المتطلبات الأساسية:** لا شيء

يمكنك استخدام أمر `secretlint` بدون Node.js عن طريق استخدام ملف ثنائي قابل للتنفيذ مفرد.

1. قم بتنزيل أحدث ملف ثنائي من [صفحة الإصدارات](https://github.com/secretlint/secretlint/releases)
2. غيّر صلاحية الملف ليكون قابلاً للتنفيذ: `chmod +x ./secretlint`
3. قم بتشغيل `./secretlint --init` لإنشاء ملف تكوين
4. قم بتشغيل `./secretlint "**/*"` لفحص مشروعك

لمزيد من التفاصيل، يُرجى الاطلاع على ملف README الخاص بـ [publish/binary-compiler](https://github.com/secretlint/secretlint/blob/HEAD/publish/binary-compiler).

## الاستخدام

يُظهر `secretlint --help` طريقة الاستخدام.

    Secretlint CLI that scan secret/credential data.
    
    Usage
    $ secretlint [file|glob*]
    
    Note
    supported glob syntax is based on picomatch (the engine used by micromatch)
    https://github.com/micromatch/picomatch#globbing-features
    https://github.com/micromatch/micromatch#matching-features
    
    Options
    --init             setup config file. Create .secretlintrc.json file from your package.json
    --format           [String] formatter name. Default: "stylish". Available Formatter: checkstyle, compact, github, jslint-xml, junit, pretty-error, stylish, tap, unix, json, mask-result, table
    --output           [path:String] output file path that is written of reported result.
    --secretlintrc     [path:String] path to .secretlintrc config file. Default: .secretlintrc.*
    --secretlintignore [path:String] path to .secretlintignore file. Default: .secretlintignore
    --stdinFileName    [String] filename to process STDIN content. Some rules depend on filename to check content.
    --no-color         disable ANSI-color of output.
    --no-terminalLink  disable terminalLink of output.
    --no-maskSecrets   disable masking of secret values; secrets are masked by default.
    --no-glob          disable glob pattern interpretation; treat all inputs as literal file paths.
    --no-gitignore     disable .gitignore cascade respect; .gitignore files are
                       respected by default (since v13).
    
    Options for Developer
    --profile          Enable performance profile.
    --secretlintrcJSON [String] a JSON string of .secretlintrc. use JSON string instead of rc file.
    
    Experimental Options
    --locale            [String] locale tag for translating message. Default: en
    
    Examples
    # Scan a single file
    $ secretlint ./README.md

    # Scan all files (wrap glob in double quotes to avoid shell expansion)
    $ secretlint "**/*"
    $ secretlint "source/**/*.ini"

    # Treat inputs as literal paths (for SvelteKit (group) / Next.js [param] etc.)
    $ secretlint --no-glob "src/(auth)/login.ts"

    # Lint STDIN content (filename hint affects which rules apply)
    $ echo "SECRET" | secretlint --stdinFileName=secret.txt

    # Use a custom config file
    $ secretlint "**/*" --secretlintrc=.secretlintrc.custom.json

    # Scan files ignored by .gitignore (e.g. to verify build artifacts)
    $ secretlint --no-gitignore "dist/**/*"

    # Mask secrets in a file in-place
    $ secretlint .zsh_history --format=mask-result --output=.zsh_history

    # Output JSON for programmatic parsing
    $ secretlint "**/*" --format=json --output=secretlint-report.json

    # Output GitHub Actions annotations in CI
    $ secretlint "**/*" --format=github
    
    Exit Status
    Secretlint exits with the following values:
    
        - 0:
          - Linting succeeded, no errors found.
          - Found lint error but --output is specified.
        - 1:
          - Linting failed, errors found.
        - 2:
          - Unexpected error occurred, fatal error.


## التكوين

يحتوي Secretlint على ملف تكوين `.secretlintrc.{json,yml,js}`.

- الوثائق: [تكوين Secretlint](https://github.com/secretlint/secretlint/blob/HEAD/docs/configuration.md)

بعد تشغيل `secretlint --init`، سيكون لديك ملف `.secretlintrc.json` في دليلك.

سترى بداخله بعض القواعد المهيأة هكذا:```json
{
  "rules": [
    {
      "id": "@secretlint/secretlint-rule-preset-recommend"
    }
  ]
}

عند استخدام إعداد مسبق مثل `@secretlint/secretlint-rule-preset-recommend`، يجب وضع الخيار في `rules`.

على سبيل المثال، خيار لـ `@secretlint/secretlint-rule-preset-recommend > @secretlint/secretlint-rule-aws````json5
{
  "rules": [
    {
      "id": "@secretlint/secretlint-rule-preset-recommend",
      "rules": [
        {
          "id": "@secretlint/secretlint-rule-aws",
            "options": {
              "allows": [
	            // it will be ignored
                "xxxx-xxxx-xxxx-xxxx-xxxx"
              ]
            }
        }
      ]
    }
  ]
}

معرف رسالة هذا الخطأ هو `EXAMPLE_MESSAGE` في `@secretlint/secretlint-rule-example`.

إذا كنت ترغب في تجاهل هذا الخطأ، فيرجى استخدام `allowMessageIds`.```json
{
  "rules": [
    {
      "id": "@secretlint/secretlint-rule-example",
      "allowMessageIds": ["EXAMPLE_MESSAGE"]
    }
  ]
}

{
    "rules": [
        {
            "id": "@secretlint/secretlint-rule-aws",
            "options": {
                "allows": [
                    "AWSAccountID",
                    "AWSAccessKeyID"
                ]
            }
        }
    ]
}
``````json5
{
  "rules": [
    {
      "id": "@secretlint/secretlint-rule-preset-recommend",
      "rules": [
        {
          "id": "@secretlint/secretlint-rule-aws",
          "allowMessageIds": ["AWSAccountID", "AWSAccessKeyID"]
        }
      ]
    }
  ]
}

> **الانتقال إلى الإصدار v13:**
> - يتم الآن احترام ملف `.gitignore` افتراضيًا. في السابق، كان secretlint يفحص جميع الملفات المتطابقة بغض النظر عن `.gitignore`. استخدم الخيار `--no-gitignore` لاستعادة السلوك السابق.
> - أنماط التضمين تتبع تركيب glob الخاص بـ picomatch (التوسيع بالأقواس المتعرجة، `**`، فئات الأحرف، …). مكدس التجاهل المتسلسل (`.gitignore`، `.secretlintignore`، وقائمة التجاهل المضمنة) يتبع دلالات `.gitignore` القياسية، والتي **لا تدعم** التوسيع بالأقواس المتعرجة — اكتب `**/.cache` بدلاً من `**/{cache,tmp}` لأنماط التجاهل.
> - يتم تفسير الأنماط على أنها globs بشكل افتراضي. عندما يتطابق نمط مع مسار موجود على القرص، يعامله الباحث حرفيًا حتى لو كان الاسم يحتوي على أحرف glob وصفية (`[`، `(`، `{`، `?`)، مما يعكس السلوك القديم `convertPathToPattern` الخاص بـ globby. استخدم الخيار `--no-glob` لفرض المعالجة الحرفية للمسارات التي لا توجد بعد على القرص.
> - يتم اتباع الروابط الرمزية للدلائل أثناء البحث (مطابقة للسلوك السابق المعتمد على globby) لكن مسار الرابط الرمزي — وليس الهدف الذي تم حله — هو ما تراه قواعد `.gitignore` و `.secretlintignore`. يتم اكتشاف الدورات عبر `realpath` بحيث يتم الدخول إلى كل هدف فريد مرة واحدة على الأكثر.

### التجاهل عبر التعليقات

يدعم [@secretlint/secretlint-rule-filter-comments](https://www.npmjs.com/package/@secretlint/secretlint-rule-filter-comments) التعليقات المهملة مثل `secretlint-disable`.```
// secretlint-disable

THIS IS SECRET, BUT IT WILL BE IGNORED

// secretlint-enable

لعرض القيم السرية الفعلية في المخرجات، استخدم `--no-maskSecrets`:```bash
$ secretlint --no-maskSecrets "**/*"

## حزم القواعد

تم تنفيذ قواعد Secretlint كوحدات منفصلة.

- [@secretlint/secretlint-rule-npm](https://github.com/secretlint/secretlint/blob/HEAD/packages/@secretlint/secretlint-rule-npm)
- [@secretlint/secretlint-rule-aws](https://github.com/secretlint/secretlint/blob/HEAD/packages/@secretlint/secretlint-rule-aws)
- [@secretlint/secretlint-rule-gcp](https://github.com/secretlint/secretlint/blob/HEAD/packages/@secretlint/secretlint-rule-gcp)
- [@secretlint/secretlint-rule-github](https://github.com/secretlint/secretlint/blob/HEAD/packages/@secretlint/secretlint-rule-github)
- [@secretlint/secretlint-rule-gitlab](https://github.com/secretlint/secretlint/blob/HEAD/packages/@secretlint/secretlint-rule-gitlab)
- [@secretlint/secretlint-rule-privatekey](https://github.com/secretlint/secretlint/blob/HEAD/packages/@secretlint/secretlint-rule-privatekey)
- [@secretlint/secretlint-rule-basicauth](https://github.com/secretlint/secretlint/blob/HEAD/packages/@secretlint/secretlint-rule-basicauth)
- [@secretlint/secretlint-rule-slack](https://github.com/secretlint/secretlint/blob/HEAD/packages/@secretlint/secretlint-rule-slack)
- [@secretlint/secretlint-rule-sendgrid](https://github.com/secretlint/secretlint/blob/HEAD/packages/@secretlint/secretlint-rule-sendgrid)
- [@secretlint/secretlint-rule-shopify](https://github.com/secretlint/secretlint/blob/HEAD/packages/@secretlint/secretlint-rule-shopify)
- [@secretlint/secretlint-rule-stripe](https://github.com/secretlint/secretlint/blob/HEAD/packages/@secretlint/secretlint-rule-stripe)
- [@secretlint/secretlint-rule-openai](https://github.com/secretlint/secretlint/blob/HEAD/packages/@secretlint/secretlint-rule-openai)
- [@secretlint/secretlint-rule-anthropic](https://github.com/secretlint/secretlint/blob/HEAD/packages/@secretlint/secretlint-rule-anthropic)
- [@secretlint/secretlint-rule-grafana](https://github.com/secretlint/secretlint/blob/HEAD/packages/@secretlint/secretlint-rule-grafana)
- [@secretlint/secretlint-rule-groq](https://github.com/secretlint/secretlint/blob/HEAD/packages/@secretlint/secretlint-rule-groq)
- [@secretlint/secretlint-rule-linear](https://github.com/secretlint/secretlint/blob/HEAD/packages/@secretlint/secretlint-rule-linear)
- [@secretlint/secretlint-rule-1password](https://github.com/secretlint/secretlint/blob/HEAD/packages/@secretlint/secretlint-rule-1password)
- [@secretlint/secretlint-rule-database-connection-string](https://github.com/secretlint/secretlint/blob/HEAD/packages/@secretlint/secretlint-rule-database-connection-string)
- [@secretlint/secretlint-rule-databricks](https://github.com/secretlint/secretlint/blob/HEAD/packages/@secretlint/secretlint-rule-databricks)
- [@secretlint/secretlint-rule-hashicorp-vault](https://github.com/secretlint/secretlint/blob/HEAD/packages/@secretlint/secretlint-rule-hashicorp-vault)
- [@secretlint/secretlint-rule-vercel](https://github.com/secretlint/secretlint/blob/HEAD/packages/@secretlint/secretlint-rule-vercel)
- [@secretlint/secretlint-rule-azure](https://github.com/secretlint/secretlint/blob/HEAD/packages/@secretlint/secretlint-rule-azure)
- [@secretlint/secretlint-rule-docker](https://github.com/secretlint/secretlint/blob/HEAD/packages/@secretlint/secretlint-rule-docker)
- [@secretlint/secretlint-rule-figma](https://github.com/secretlint/secretlint/blob/HEAD/packages/@secretlint/secretlint-rule-figma)
- [@secretlint/secretlint-rule-cloudflare](https://github.com/secretlint/secretlint/blob/HEAD/packages/@secretlint/secretlint-rule-cloudflare)
- [@secretlint/secretlint-rule-tailscale](https://github.com/secretlint/secretlint/blob/HEAD/packages/@secretlint/secretlint-rule-tailscale)
- [@secretlint/secretlint-rule-huggingface](https://github.com/secretlint/secretlint/blob/HEAD/packages/@secretlint/secretlint-rule-huggingface)
- [@secretlint/secretlint-rule-notion](https://github.com/secretlint/secretlint/blob/HEAD/packages/@secretlint/secretlint-rule-notion)
- [@secretlint/secretlint-rule-secp256k1-privatekey](https://github.com/secretlint/secretlint/blob/HEAD/packages/@secretlint/secretlint-rule-secp256k1-privatekey)
- [@secretlint/secretlint-rule-no-k8s-kind-secret](https://github.com/secretlint/secretlint/blob/HEAD/packages/@secretlint/secretlint-rule-no-k8s-kind-secret)
- [@secretlint/secretlint-rule-pattern](https://github.com/secretlint/secretlint/blob/HEAD/packages/@secretlint/secretlint-rule-pattern)
- [@secretlint/secretlint-rule-no-homedir](https://github.com/secretlint/secretlint/blob/HEAD/packages/@secretlint/secretlint-rule-no-homedir)
- [@secretlint/secretlint-rule-no-dotenv](https://github.com/secretlint/secretlint/blob/HEAD/packages/@secretlint/secretlint-rule-no-dotenv)
- [@secretlint/secretlint-rule-filter-comments](https://github.com/secretlint/secretlint/blob/HEAD/packages/@secretlint/secretlint-rule-filter-comments)

أيضًا، توفر Secretlint مجموعة قواعد مسبقة تتضمن مجموعة القواعد الموصى بها.

- [@secretlint/secretlint-rule-preset-recommend](https://github.com/secretlint/secretlint/blob/HEAD/packages/@secretlint/secretlint-rule-preset-recommend)
    - مجموعة القواعد الموصى بها

## قواعد مخصصة

يمكنك إنشاء قواعد secretlint الخاصة بك.

إذا كنت ترغب في الحصول على قاعدة secretlint مناسبة لمشروعك، فيمكنك إنشاؤها!
قاعدة secretlint هي مجرد حزمة npm.

إذا كنت تريد معرفة كيفية إنشاء قاعدة secretlint، فيرجى الاطلاع على [docs/secretlint-rule.md](https://github.com/secretlint/secretlint/blob/HEAD/docs/secretlint-rule.md).

## التكاملات

### خطاف ما قبل الالتزام لكل مشروع

يمكنك استخدام Secretlint مع بعض أدوات ما قبل الالتزام.
يمكن أن يمنع ذلك ارتكاب البيانات السرية عن طريق التحليل باستخدام Secretlint.

تطبيق secretlint على المشروع وتحسين الأمان في تطوير الفريق.

#### [Husky](https://github.com/typicode/husky) + [lint-staged](https://github.com/okonet/lint-staged)

**حالة الاستخدام:** إذا كنت ترغب في إدخال secretlint في مشروع Node.js، فهذا المزيج مفيد.

قم بتثبيت [Husky](https://github.com/typicode/husky) و[lint-staged](https://github.com/okonet/lint-staged):```
npx husky-init && npm install lint-staged --save-dev

تعديل `package.json`:```json5
{
  // add "lint-staged" field
  "lint-staged": {
    "*": [
      "secretlint --no-glob"
    ]
  }
}

# macOS. see also https://pre-commit.com/#install
brew install pre-commit

مثال لتهيئة المستودع:

- https://github.com/azu/secretlint-pre-commit-example

#### نص Bash

بدلاً من ذلك، يمكنك حفظ هذا النص باسم `.git/hooks/pre-commit` ومنحه صلاحية التنفيذ (`chmod +x .git/hooks/pre-commit`):```bash
#!/bin/sh
FILES=$(git diff --cached --name-only --diff-filter=ACMR | sed 's| |\\ |g')
[ -z "$FILES" ] && exit 0

# Secretlint all selected files
echo "$FILES" | xargs ./node_modules/.bin/secretlint --no-glob
# If you using docker
# echo "$FILES" | xargs docker run -v `pwd`:`pwd` -w `pwd` --rm secretlint/secretlint secretlint
RET=$?
if [ $RET -eq 0 ] ;then
    exit 0
else
    exit 1
fi

بعد إعداد `core.hooksPath`، يقوم secretlint بفحص أي ملف قبل تنفيذ الالتزام به.

لمزيد من التفاصيل، راجع مشروع [secretlint/git-hooks](https://github.com/secretlint/git-hooks).

يمكن استخدام إصدار Node.js أيضًا لتطبيق git hook العام.
إذا كنت مهتمًا بذلك، فالرجاء مراجعة [@azu/git-hooks](https://github.com/azu/git-hooks).

### CI

#### GitHub Actions

إذا كنت قد قمت بالفعل بإعداد secretlint [باستخدام Node.js](#using-nodejs)، فيمكنك تشغيل secretlint باستخدام إعداداتك على [GitHub Actions](https://github.co.jp/features/actions).

ضع ملف `.github/workflows/secretlint.yml` في المستودع الخاص بك.```yaml
name: Secretlint
on: [push, pull_request]
permissions:
  contents: read
jobs:
  test:
    name: "Secretlint"
    runs-on: ubuntu-latest
    steps:
      - name: checkout
        uses: actions/checkout@v3
      - name: setup Node.js
        uses: actions/setup-node@v3
        with:
          node-version: 22
      - name: Install
        run: npm ci
      - name: Lint with Secretlint
        run: npx secretlint "**/*"

يقوم هذا الإعداد بدمج تعليقات مراجعة طلبات السحب.

![github-actions.png](https://assets.kitploit.com/production/public/readmes/6649/c4558d395907512504eb827499bbb28e442b4dd57164ca6bd64b836a0e2988eb.png)

- المستودع النموذجي: https://github.com/secretlint/secretlint-github-actions-example
- طلب السحب النموذجي: https://github.com/secretlint/secretlint-github-actions-example/pull/1/files

إذا كنت ترغب في فحص الملفات المختلفة فقط، يُرجى الاطلاع على المثال التالي:```yaml
name: test-diff
on:
  push:
  pull_request:
jobs:
  test-diff:
    permissions:
      contents: read
    name: "Run secretlint to diff files"
    runs-on: ubuntu-latest
    steps:
      - name: checkout
        uses: actions/checkout@v4
        with:
          # fetch history to get all changed files on push or pull_request event
          fetch-depth: 0
      - name: Get changed files
        id: changed-files
        uses: tj-actions/changed-files@v44
        with:
          quotepath: "false"
      - name: setup Node ${{ matrix.node-version }}
        uses: actions/setup-node@v4
        with:
          node-version: 22
      - name: Show changed files
        run: echo "${{ steps.changed-files.outputs.all_changed_files }}"
      - name: Install
        if: steps.changed-files.outputs.any_changed == 'true'
        run: npm ci
      - name: Run secretlint
        if: steps.changed-files.outputs.any_changed == 'true'
        run: npx secretlint --no-glob ${{ steps.changed-files.outputs.all_changed_files }}

![megalinter-secretlint-failure.png](https://assets.kitploit.com/production/public/readmes/6649/3db15386c6559c762029a095a5f3c0d83bb55255d261809254296d55fa6d6748.png)

### المتصفح

[Secretlint WebExtension](https://github.com/secretlint/webextension) يعمل على متصفحك.

- Firefox: <https://addons.mozilla.org/ja/firefox/addon/secretlint/>
- Chrome: <https://chrome.google.com/webstore/detail/secretlint/hidpojbnemkajlnibhmeilpgoddkjjkf>

تهدف هذه الإضافة للمتصفح إلى العثور على بيانات الاعتماد المضمنة في طلبك/استجابتك.

![Secretlint WebExtension](https://assets.kitploit.com/production/public/readmes/6649/ecb458b32d60007d85b13d2c238cb235e0ac856c7cbea6590fde520e3bcf07f0.png)

تتكامل إضافة Secretlint WebExtension مع DevTools في Chrome/Firefox.
تساعد هذه الإضافة مطوري الويب على ملاحظة بيانات الاعتماد المكشوفة.

### macOS

[SecureClipboard](https://github.com/secretlint/secure-clipboard) هو تطبيق شريط قوائم لنظام macOS يستخدم Secretlint لاكتشاف وإخفاء الأسرار في الحافظة الخاصة بك قبل لصقها في مكان آخر.

### أخرى

#### SARIF format support

يرجى استخدام [@secretlint/secretlint-formatter-sarif](https://github.com/secretlint/secretlint/blob/HEAD/packages/@secretlint/secretlint-formatter-sarif).```
npm install @secretlint/secretlint-formatter-sarif --dev
secretlint --format @secretlint/secretlint-formatter-sarif "**/*"

لمزيد من التفاصيل، يرجى الاطلاع على [CONTRIBUTING.md](https://github.com/secretlint/secretlint/blob/HEAD/CONTRIBUTING.md)

### المعيار

يتم تشغيل سير عمل المعيار في كل commit.

- المعيار: https://secretlint.github.io/secretlint/dev/bench/

## المؤلف

- [github/azu](https://github.com/azu)
- [twitter/azu_re](https://twitter.com/azu_re)

## الترخيص

MIT © azu