technical reference manual • v1.0

CodeMind Reference Manual

Learn how to hook repository pipelines, authenticate via CLI keys, and script Gemini rules.

1. Getting Started

CodeMind AI integrates directly into your compiler toolchains to scan code representations using Abstract Syntax Trees (ASTs). To initiate scanning, create an account, navigate to the Projects Ledger, and connect a target folder or repository.

QUICK SHELL INITIATION
$ npx codemind-cli scan --path ./src --key cm_sk_live_xxxx

2. API & Secret Key Authentication

API commands require bearer key authentication. Generate secrets inside the API Shield dashboard panel. All keys are prefixed with cm_sk_live_ and should be stored securely.

Example Authorization Header
GET /api/v1/projects HTTP/1.1
Host: connect-315o.onrender.com
Authorization: Bearer cm_sk_live_dbd89240fc...

3. Git Pipeline Shield Hooks

Integrate CodeMind as an automated Gatekeeper inside your continuous integration pipelines. Enable webhooks in the Settings module to receive automatic commit payload analysis updates.

GitHub Workflow Integration Script
name: CodeMind Audit Gate
on: [push, pull_request]
jobs:
  audit:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - run: npm install -g @codemind/cli
      - run: codemind-audit --fail-on-critical

4. Rulebook Prompt Scripting

The Rulebook allows corporate policy injection directly inside Gemini's prompt framework. Directives can verify formatting, check imports structures, or prevent SQL injections.

Enforcement Example
"- Force all Next.js layouts to export static metadata headers to enforce global SEO standards."