> ## Documentation Index
> Fetch the complete documentation index at: https://docs.coconut.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Get instruction files

> Retrieve the contents of instruction/guidance files (README.md, CLAUDE.md, GEMINI.md, AGENTS.md)
from all directories in the repository. Returns a nested object keyed by directory path,
where each value maps filenames to their content.




## OpenAPI

````yaml /api-reference/openapi.yaml get /api/v1/git/instruction-files
openapi: 3.1.1
info:
  title: Coconut API
  description: |
    Comprehensive API for the Coconut development platform.

    Coconut is a development environment that provides AI-assisted coding,
    task management, skill orchestration, and integrated terminal sessions.
  version: 1.0.72
  contact:
    name: Coconut Team
  license:
    name: MIT
servers:
  - url: http://localhost:3001
    description: Development server
  - url: '{baseUrl}'
    description: Production server
    variables:
      baseUrl:
        default: http://localhost:3001
        description: Base URL for the API
security:
  - sessionCookie: []
  - bearerAuth: []
  - apiKey: []
tags:
  - name: Tasks
    description: Task management
  - name: Skills
    description: AI skill configuration and management (Agent Skills spec)
  - name: Resources
    description: File and media resource management
  - name: Knowledge
    description: Knowledge document management
  - name: Terminal
    description: Terminal session management
  - name: AI
    description: AI chat and completion endpoints
  - name: Chats
    description: Chat history management
  - name: Configuration
    description: Project and global configuration
  - name: MCP
    description: Model Context Protocol server management
  - name: Context
    description: Context documents for role, agents, team, and memory
  - name: Identity
    description: Identity and agent card management
  - name: User
    description: User information and settings
  - name: Jobs
    description: Scheduled job management
  - name: Git
    description: Git repository management
  - name: Slack
    description: Slack integration and notification management
  - name: Mail
    description: Email management and Resend webhook integration
  - name: Version
    description: API version information
paths:
  /api/v1/git/instruction-files:
    get:
      tags:
        - Git
      summary: Get instruction files
      description: >
        Retrieve the contents of instruction/guidance files (README.md,
        CLAUDE.md, GEMINI.md, AGENTS.md)

        from all directories in the repository. Returns a nested object keyed by
        directory path,

        where each value maps filenames to their content.
      operationId: gitInstructionFiles
      parameters:
        - name: kind
          in: query
          required: false
          description: Filter to a specific file kind, or "all" (default) for every match.
          schema:
            type: string
            enum:
              - README
              - CLAUDE
              - GEMINI
              - AGENTS
              - COPILOT
              - CODEX
              - all
            default: all
      responses:
        '200':
          description: Instruction files grouped by directory
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    type: object
                    description: Directory path -> { filename -> content }
                    additionalProperties:
                      type: object
                      properties:
                        README:
                          type: string
                        CLAUDE:
                          type: string
                        GEMINI:
                          type: string
                        AGENTS:
                          type: string
                        COPILOT:
                          type: string
                        CODEX:
                          type: string
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  responses:
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InternalError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    ErrorResponse:
      type: object
      required:
        - success
        - error
      properties:
        success:
          type: boolean
          const: false
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: Error code
            message:
              type: string
              description: Human-readable error message
  securitySchemes:
    sessionCookie:
      type: apiKey
      in: cookie
      name: nut-session
      description: Session cookie authentication
    bearerAuth:
      type: http
      scheme: bearer
      description: Bearer token authentication
    apiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key authentication

````