.AIIgnore · Schema

AIToolCompatibility

Compatibility record showing which AI tools support a given .aiignore syntax

AI AgentsConfigurationDeveloper WorkflowSecurityPrivacyDeveloper ToolsLLMSecrets Management

Properties

Name Type Description
tool_name string Name of the AI coding tool
file_name string The actual ignore file name this tool uses
syntax string Ignore file syntax type
scope string Where file should be placed
documentation_url string Link to tool documentation
View JSON Schema on GitHub

JSON Schema

aiignore-ai-tool-compatibility-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aiignore/refs/heads/main/json-schema/aiignore-ai-tool-compatibility-schema.json",
  "title": "AIToolCompatibility",
  "description": "Compatibility record showing which AI tools support a given .aiignore syntax",
  "type": "object",
  "properties": {
    "tool_name": {
      "type": "string",
      "description": "Name of the AI coding tool",
      "example": "JetBrains AI Assistant"
    },
    "file_name": {
      "type": "string",
      "description": "The actual ignore file name this tool uses",
      "example": ".aiignore"
    },
    "syntax": {
      "type": "string",
      "description": "Ignore file syntax type",
      "example": "gitignore-compatible"
    },
    "scope": {
      "type": "string",
      "description": "Where file should be placed",
      "example": "project root"
    },
    "documentation_url": {
      "type": "string",
      "format": "uri",
      "description": "Link to tool documentation",
      "example": "https://www.jetbrains.com/help/idea/ai-assistant.html"
    }
  }
}