AI Tools

Centralized documentation for AI-assisted coding tools, standards, patterns, and personal observations. This repository serves as the single source of truth for all AI tool configurations across projects.

Overview

This system uses a reference-based approach: projects contain minimal configuration files (warp.md, .cursorrules, .continue-config) that point back to this centralized documentation. This ensures consistency across projects while allowing project-specific overrides.

Table of Contents

• Directory Structure
• Quick Start
• Using Templates
• Journaling
• Documentation
• Maintenance

Directory Structure

ai-tools/
├── docs/
│   ├── standards/       # Coding standards (Python, etc.)
│   ├── patterns/        # Prompt patterns and AI workflows
│   ├── guides/          # Tool-specific guides (Ollama, etc.)
│   ├── USAGE.md         # How to integrate with projects
│   └── MAINTENANCE.md   # System maintenance guide
├── templates/           # Config templates for projects
│   ├── warp.md.template
│   ├── .cursorrules.template
│   ├── .continue-config.template
│   ├── .github-copilot.template
│   └── .openai-codex.template
├── journal/
│   └── YYYY/            # Daily files: YYYY-MM-DD.md
├── scripts/
│   ├── setup-project.sh # Initialize project with templates
│   └── journal.sh       # Quick journal entries helper
└── README.md            # This file

Quick Start

For New Projects

1. Run the setup script with your project path:

~/ai-tools/scripts/setup-project.sh /path/to/project project-domain

Example:

~/ai-tools/scripts/setup-project.sh ~/projects/my-app web-app

Common project domains:

• web-app - Web applications
• mobile-app-flutter - Flutter cross-platform mobile apps
• mobile-app-ios - Native iOS apps (Swift/SwiftUI)
• mobile-app-android - Native Android apps (Kotlin/Jetpack Compose)
• cli-tool - Command-line tools
• library - Shared libraries or packages
• api-service - Backend API services
• data-science - Data analysis/ML projects
• desktop-app - Desktop applications

2. Edit the generated files (warp.md, .cursorrules, .continue-config) and replace __ADDITIONAL_RULES__ with project-specific rules.

For Existing Projects

Add references to centralized docs in your existing config files. See docs/USAGE.md for details.

Using Templates

Templates use these placeholders:

• __CENTRAL_DOCS__ - Path to centralized docs (default: ~/ai-tools/docs)
• __PROJECT_NAME__ - Project name (derived from directory)
• __PROJECT_PATH__ - Absolute path to project
• __PROJECT_DOMAIN__ - Project category/type (e.g., web-app, mobile-app-flutter, mobile-app-ios, mobile-app-android, cli-tool, library, api-service, data-science, desktop-app)
• __ADDITIONAL_RULES__ - Project-specific rules (you fill this in)

The setup script automatically replaces placeholders except __ADDITIONAL_RULES__, which you customize manually.

Journaling

Track your personal observations and learnings about AI tool usage:

Format: journal/YYYY/YYYY-MM-DD.md

Quick entry:

~/ai-tools/scripts/journal.sh Your observation here

Manual entry: Edit today's file directly

Note: Journal is for your personal thoughts only - not for automated logging.

See journal/README.md for details.

Documentation

Standards

Language-specific coding standards:

• Python - Black, Ruff, mypy, pytest
• Dart/Flutter - dart format, flutter analyze, cross-platform
• Swift/Apple - SwiftLint, SwiftFormat, iOS/macOS/watchOS

The system is language-agnostic - add standards for any language your projects use.

Guides

• Ollama Local Setup - Local LLM setup with Continue
• OpenAI Codex - Codex evolution: original API (deprecated 2023) and new suite (2024-2025)
• Python Library Packaging - PyPI publishing with GitHub Actions automation

Usage

• Project Integration Guide - How to use this system
• Maintenance Guide - Updating and evolving the system

Supported Tools

• Warp Terminal - Uses warp.md in project root
• Cursor - Uses .cursorrules in project root
• Continue (VS Code) - Uses .continue-config in project root
• GitHub Copilot - Uses .github-copilot in project root with in-code comment references
• OpenAI Codex (VS Code) - Uses .openai-codex in project root (requires ChatGPT Plus/Pro/Business/Enterprise)

Maintenance

See docs/MAINTENANCE.md for:

• Adding/updating standards and patterns
• Template evolution
• Version management
• Journal housekeeping