---
title: "Test .gitignore or glob patterns against a list of paths and see which rule matched each one."
method: POST
path: "/api/v1/glob-tester"
tags: ["Web Tools"]
---

# Test .gitignore or glob patterns against a list of paths and see which rule matched each one.

`POST /api/v1/glob-tester`

## Request

- Base URL: `https://programmes.net`
- URL: `https://programmes.net/api/v1/glob-tester`
- Auth: none declared

Glob & .gitignore Tester. Operations: `test` — Match paths against gitignore rules (negation, anchoring, **, directory-only) or plain globs.

## Request body

- GlobTesterTest: Match paths against gitignore rules (negation, anchoring, **, directory-only) or plain globs.
  - `operation` 'test', required
  - `input` string: Paths to test, one per line; end a directory with / (e.g. build/ or src/app.js).
  - `options` object, required
    - `patterns` string, required: The patterns, one per line, as in a .gitignore file.
    - `mode` 'gitignore' | 'glob': gitignore: git’s rules (last match wins, excluded parents stay excluded); glob: each pattern against the whole path, with {a,b}.
    - `ignoreCase` boolean: Match case-insensitively (core.ignorecase).

## Response `200`

The operation ran.

- object
  - `ok` unknown, required
  - `tool` 'glob-tester', required
  - `operation` 'test', required
  - `result` unknown, required

## Other responses

- `400`: The request is not valid (https://programmes.net/api#invalid-request); The tool has no such operation (https://programmes.net/api#unknown-operation)
- `404`: No such tool (https://programmes.net/api#unknown-tool)
- `413`: The request or its input is too large (https://programmes.net/api#content-too-large)
- `415`: The body must be JSON (https://programmes.net/api#unsupported-media-type)
- `422`: An option is missing, of the wrong type or out of range (https://programmes.net/api#invalid-options); This call needs more CPU than one API call may use (https://programmes.net/api#refused); The operation could not process the input (https://programmes.net/api#tool-error)
- `429`: Too many requests (https://programmes.net/api#rate-limited)
- `500`: Internal error (https://programmes.net/api#internal-error)

---

[API](https://skmtc.dev/programmes/apis/programmes-net-api.md) · [All operations](https://skmtc.dev/programmes/apis/programmes-net-api/llms.txt) · [OpenAPI document](https://skmtc.dev/programmes/apis/programmes-net-api/revisions/aa939784a2e6?raw)