@eldrforge/kodrdriv 0.0.14 → 0.0.17

package/docs/public/README.md

@@ -1,132 +0,0 @@
-# KodrDriv
-
-KodrDriv is a powerful utility designed to automatically generate intelligent release notes and commit messages from your Git repository. It analyzes commit history, pull requests, and related metadata to create comprehensive, well-structured documentation of your project's evolution. By leveraging advanced AI-powered analysis, it helps teams maintain clear visibility into their codebase's development history while reducing the manual effort typically required for changelog maintenance.
-
-## What is KodrDriv?
-
-KodrDriv is an AI-powered Git workflow automation tool designed to solve the common problem of writing meaningful commit messages and release notes. It provides a unified way to:
-
-- **Generate intelligent commit messages** from your code changes
-- **Create comprehensive release notes** automatically from Git history
-- **Automate the entire release process** with pull request and GitHub integration
-- **Manage workspace dependencies** for monorepo and multi-package development
-- **Maintain consistent documentation** with minimal manual effort
-
-## Why KodrDriv?
-
-Writing good commit messages and release notes is time-consuming and often done when you're least in the mood for reflection. **KodrDriv was created specifically to solve the "context switch" problem that happens when you've been deep in code and Git asks you to summarize what you've done.**
-
-Without KodrDriv, you need to manually:
-- Stop your flow to write commit messages
-- Remember all the changes you made across multiple files
-- Craft meaningful release notes from scattered commit messages
-- Coordinate complex release workflows with multiple steps
-
-KodrDriv reads your code changes and Git history to automatically generate contextual, meaningful documentation that reflects your actual work.
-
-## Installation
-
-Install KodrDriv globally using npm:
-
-```bash
-npm install -g @eldrforge/kodrdriv
-```
-
-This will make the `kodrdriv` command available globally on your system.
-
-## Quick Start
-
-Here's how to get started with KodrDriv:
-
-### Generate a Commit Message
-
-```bash
-# Make some changes to your code
-git add .
-kodrdriv commit
-```
-
-### Generate Release Notes
-
-```bash
-# Generate release notes from your recent changes
-kodrdriv release
-```
-
-### Automate Your Release Process
-
-```bash
-# Fully automated release with dependency updates, PR creation, and GitHub release
-kodrdriv publish
-```
-
-### Link Local Packages for Development
-
-```bash
-# Automatically link workspace packages for local development
-kodrdriv link --scope-roots '{"@company": "../"}'
-```
-
-## Key Features
-
-### AI-Powered Analysis
-Uses OpenAI models to understand your code changes and generate contextual commit messages and release notes.
-
-### Comprehensive Release Automation
-The `publish` command handles dependency updates, version bumping, PR creation, status checks, merging, and GitHub releases.
-
-### Intelligent Workspace Management
-Automatically discovers and links related packages in monorepos and multi-package projects.
-
-### Flexible Configuration
-Supports hierarchical configuration with command-line overrides, config files, and environment variables.
-
-### Custom Instructions
-Extend or replace default AI instructions to match your project's specific conventions and requirements.
-
-## Documentation
-
-📚 **Complete Documentation**
-
-**Quick Links:**
-- [Commands](docs/public/commands.md) - Detailed documentation of all commands (commit, release, publish, link)
-- [Configuration](docs/public/configuration.md) - All configuration options, hierarchical config, and environment variables  
-- [Advanced Usage](docs/public/advanced-usage.md) - Custom instructions, context, prompt structure, and advanced features
-- [Examples](docs/public/examples.md) - Practical usage examples and common workflows
-
-## Basic Command Options
-
-- `--dry-run`: Perform a dry run without saving files
-- `--verbose`: Enable verbose logging  
-- `--debug`: Enable debug logging
-- `--check-config`: Display current configuration hierarchy
-- `--version`: Display version information
-
-For complete command-line options and detailed usage, see the [Configuration Documentation](docs/public/configuration.md).
-
-## Environment Variables
-
-KodrDriv requires OpenAI API credentials for AI-powered features:
-
-- `OPENAI_API_KEY`: OpenAI API key (required)
-- `GITHUB_TOKEN`: Required for publish command and GitHub operations
-
-## Contributing
-
-We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
-
-## License
-
-Apache-2.0 - see [LICENSE](LICENSE) file for details.
-
-## About the Name
-
-Ski carving and efficient software development have a lot in common. Carving uses edge control to follow a smooth, energy-efficient arc — just like automation uses clean, repeatable scripts to replace manual work. Both are about flow: linking turns or commits without hesitation. As carving unlocks speed and control, automation unlocks scalability and momentum. The result is clean tracks — razor-thin arcs on snow, or tidy diffs in code. And when you've mastered your craft, you don't stop to think about your last move. Your code leaves a clean trail — and your commit message can be automated straight from the diff.
-
-
-
-
-
-
-
-

package/docs/public/advanced-usage.md

@@ -1,188 +0,0 @@
-# Advanced Usage
-
-This section covers advanced features and customization options for KodrDriv.
-
-## Custom Instructions
-
-KodrDriv comes with default instructions that guide the AI in generating release notes or change logs. These instructions can be customized to match your project's specific needs and conventions.
-
-### Default Instructions
-
-The default instructions are defined in the source code:
-
-- **Commit Instructions**: The default instructions for commit message generation are defined in [src/prompt/instructions/commit.ts](https://github.com/eldrforge/kodrdriv/blob/main/src/prompt/instructions/commit.ts).
-
-- **Release Instructions**: The default instructions for release notes generation are defined in [src/prompt/instructions/release.ts](https://github.com/eldrforge/kodrdriv/blob/main/src/prompt/instructions/release.ts).
-
-These instruction files contain detailed guidelines for the AI on how to format and structure the output, including examples and specific requirements for different types of changes.
-
-### Customizing Instructions
-
-You can override these default instructions in several ways:
-
-1. **Command Line Option**: Use the `--instructions` flag to specify a custom instructions file:
-   ```bash
-   kodrdriv --instructions ./my-custom-instructions.txt
-   ```
-
-2. **Default Location**: Even without specifying a command line option, KodrDriv will automatically look for an instructions file at `./.kodrdriv/instructions.md` in your current working directory.
-
-3. **File Format**: While the default file is named `instructions.md`, you can use any text file with any extension. The content doesn't have to be in Markdown format - any plain text content will work. This gives you flexibility to use your preferred text editor or format for writing instructions.
-
-### Extending Default Instructions
-
-The configuration directory (configDir) allows you to further customize both commit and release instructions by adding pre and post content to the default instructions. This is done by creating additional files in your `.kodrdriv/instructions` directory:
-
-#### Release Instructions
-1. **Pre-Content**: Create a file named `release-pre.md` to add content that will be prepended to the default release instructions.
-2. **Post-Content**: Create a file named `release-post.md` to add content that should be appended to the default release instructions.
-
-#### Commit Instructions
-1. **Pre-Content**: Create a file named `commit-pre.md` to add content that will be prepended to the default commit instructions.
-2. **Post-Content**: Create a file named `commit-post.md` to add content that should be appended to the default commit instructions.
-
-For example, if you want to add specific formatting requirements before the default release instructions, you could create `.kodrdriv/instructions/release-pre.md`, and if you want to add instructions to the end of the commit instructions, you would have a file in `.kodrdriv/instructions/commit-post.md`.
-
-### Overriding Default Instructions
-
-While the pre and post content files provide a way to extend the default instructions, you can also completely replace them by creating either `commit.md` or `release.md` in your `.kodrdriv/instructions` directory. This gives you full control over the instruction content.
-
-However, please note that completely replacing the default instructions should be done with caution. The default instructions are carefully crafted to:
-- Ensure consistent formatting
-- Maintain proper context awareness
-- Follow best practices for commit messages and release notes
-- Handle edge cases and special scenarios
-
-By replacing these instructions entirely, you may lose these benefits and potentially create inconsistencies in your documentation. It's recommended to use the pre and post content files to extend the default instructions rather than replacing them entirely, unless you have a specific need to do so.
-
-To enable instruction overrides, you'll need to use the `--overrides` flag when running the command.
-
-## Context
-
-KodrDriv can use contextual information about your project to generate more meaningful commit messages and release notes. Context is provided through Markdown files stored in a dedicated directory.
-
-### Context Directory Structure
-
-The structure of your context directory is entirely up to you. There are no strict requirements for how you organize your context files - you can structure them in whatever way makes the most sense for your project and team.
-
-Here are two example approaches to organizing context files:
-
-#### Hierarchical Structure Example
-
-You can organize context in a hierarchical structure with subdirectories for different categories:
-
-```
-.kodrdriv/context/
-├── context.md                # Main context file describing sections
-├── people/                   # Directory for information about people
-│   ├── context.md            # Description of the people section
-│   ├── team-members.md       # Information about team members
-│   └── contributors.md       # Information about contributors
-├── projects/                 # Directory for project information
-│   ├── context.md            # Description of the projects section
-│   └── project-details.md    # Details about various projects
-└── technologies/             # Directory for technical information
-    ├── context.md            # Description of the technologies section
-    ├── frameworks.md         # Information about frameworks used
-    └── libraries.md          # Information about libraries used
-```
-
-#### Individual Records Example
-
-Alternatively, you can use a flatter structure with individual files for each entity:
-
-```
-.kodrdriv/context/
-├── context.md                # Main context file describing sections
-├── people/                   # Directory for individual people information
-│   ├── context.md            # Description of the people section
-│   ├── john-doe.md           # Information specific to John Doe
-│   ├── jane-smith.md         # Information specific to Jane Smith
-│   └── alex-johnson.md       # Information specific to Alex Johnson
-```
-
-Choose the organization that works best for your needs. The system will process the context files regardless of the structure, as long as they follow the basic Markdown formatting guidelines.
-
-### Main Context File
-
-The `context.md` file in each directory serves as an introduction to that section. The system loads this file first to understand the structure of the information. For example, a `context.md` file in the people directory might look like:
-
-```markdown
-## People
-
-This section contains subsections that have information about people.
-```
-
-### Context Files
-
-After loading the `context.md` file, the system reads all other Markdown files in the directory. It uses the first header in each file as the name of the section or subsection. For example:
-
-```markdown
-## Team Members
-
-- John Doe: Lead Developer, focuses on backend systems
-- Jane Smith: UX Designer, specializes in responsive interfaces
-- Alex Johnson: DevOps Engineer, manages deployment pipelines
-```
-
-### Context Location
-
-You can specify where to store your context files in two recommended ways:
-
-1. **Project Directory**: Store context files in your project repository at `.kodrdriv/context/`. This is useful when the context is specific to the project and should be versioned with the code.
-
-2. **gitignore Directory**: Alternatively, you can store context in your `.gitignore` directory if you want to keep it separate from your project files or if the context contains sensitive information that shouldn't be committed to the repository.
-
-To specify a custom context directory, use the `--context-dir` option:
-
-```bash
-kodrdriv commit --context-dir ~/my-custom-context
-```
-
-By default, KodrDriv looks for context in the `.kodrdriv/context` directory within your project.
-
-## Prompt Structure
-
-When KodrDriv sends a request to the LLM, it structures the prompt using XML-like tags to organize different components of the input. The prompt is composed of three main sections:
-
-```
-<instructions>
-[Your custom instructions or the default instructions]
-</instructions>
-
-<log>
-[Git log output if --content-types includes 'log']
-</log>
-
-<diff>
-[Git diff output if --content-types includes 'diff']
-</diff>
-```
-
-Each section serves a specific purpose:
-- `<instructions>`: Contains the guidance for the LLM on how to format and structure the output
-- `<log>`: Contains the git log output, providing commit history and messages
-- `<diff>`: Contains the git diff output, showing the actual code changes
-
-## About the Name
-
-Ski carving and efficient software development have a lot in common. Carving uses edge control to follow a smooth, energy-efficient arc — just like automation uses clean, repeatable scripts to replace manual work. Both are about flow: linking turns or commits without hesitation. As carving unlocks speed and control, automation unlocks scalability and momentum. The result is clean tracks — razor-thin arcs on snow, or tidy diffs in code. And when you've mastered your craft, you don't stop to think about your last move. Your code leaves a clean trail — and your commit message can be automated straight from the diff. And — snowboarders carve too. Different board, same beauty. We won't hold it against you if you're dropping clean edges on a single plank.
-
-## Origin Story: kodrdriv
-
-It always happened at the same moment.
-
-You've just spent the entire day in a flow state — the kind that only comes when everything clicks. Whether it was writing code for a critical feature or hammering out chapters of a Markdown or AsciiDoc book, you were locked in. Maybe you were racing the clock to hit a deadline. Maybe you were just up late trying to carve something beautiful out of nothing. Either way, you went right up to the wire, focused, dialed in, exhausted but satisfied.
-
-And then… Git hits you with the meta-question:
-"What did you do?"
-
-That one prompt — to sum it all up in a commit message — feels totally out of place. It asks you to stop, zoom out, and articulate everything you've just done, right when your brain is at its least reflective. You're not in summary mode. You're still in it. Still shaping. Still carving.
-
-And that's the thing: it sounds silly, like it shouldn't be a real problem. But every developer, every writer who lives in Git knows that exact moment. The friction is real. The context switch is jarring. It's like being asked to narrate your entire ski run after you've blasted through powder, dodged trees, hit the cliff drop — and now you're out of breath, standing at the bottom, being asked to give a PowerPoint.
-
-That's why I built kodrdriv.
-
-It's not just a tool — it's a mindset shift. The idea is simple: you've already carved your line in the snow. Your code is there. Your diffs are real. Instead of making you explain it, kodrdriv uses an LLM to read the trail you left behind and generate a clean, meaningful commit message. One that actually reflects your work — without breaking your flow or making you guess what mattered most.
-
-Whether you're merging branches or writing books, kodrdriv is built for that end-of-day moment when you want to commit and move on — not pause for existential reflection. It reads the line you've drawn, and it helps you push it forward. 

package/docs/public/code-icon.svg

@@ -1,4 +0,0 @@
-<svg xmlns="http://www.w3.org/2000/svg" width="32" height="32" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round">
-  <polyline points="16,18 22,12 16,6"></polyline>
-  <polyline points="8,6 2,12 8,18"></polyline>
-</svg> 

package/docs/public/commands.md

@@ -1,116 +0,0 @@
-# Commands
-
-KodrDriv provides four main commands for automating Git workflows and generating intelligent documentation.
-
-## Commit Command
-
-Generate intelligent commit messages:
-
-```bash
-kodrdriv commit
-```
-
-The commit command analyzes your changes and generates contextual commit messages using AI. It can work with both staged and unstaged changes.
-
-> [!TIP]
-> ### Working with Staged Changes
-> 
-> When you have staged changes using `git add`, the `kodrdriv commit` command will automatically analyze the diff of your staged changes. This allows you to selectively stage files and generate a commit message that specifically addresses those changes, rather than all uncommitted changes in your working directory.
-
-> [!TIP]
-> ### Quick Commit with --sendit
-> 
-> If you trust the quality of the generated commit messages, you can use the `--sendit` flag to automatically commit your changes with the generated message without review. This is useful for quick, routine changes where you want to streamline your workflow.
-
-### Commit Command Options
-
-- `--cached`: Use cached diff for generating commit messages
-- `--sendit`: Commit with the generated message without review (default: false)
-- `--context <context>`: Provide additional context (as a string or file path) to guide the commit message generation. This context is included in the prompt sent to the AI and can be used to specify the purpose, theme, or any special considerations for the commit.
-- `--message-limit <messageLimit>`: Limit the number of recent commit messages (from git log) to include in the prompt for context (default: 10). This can help focus the AI on the most relevant recent changes.
-
-## Release Command
-
-Generate comprehensive release notes based on changes since the last release:
-
-```bash
-kodrdriv release
-```
-
-The release command analyzes changes between two Git references and generates structured release notes.
-
-> [!TIP]
-> ### Custom Release Range
-> 
-> The `kodrdriv release` command supports customizing the range of commits to analyze using the `--from` and `--to` options. By default, it compares changes between the `main` branch and `HEAD`, but you can specify any valid Git reference (branch, tag, or commit hash) for either endpoint. This flexibility allows you to generate release notes for specific version ranges or between different branches.
-
-> [!TIP]
-> ### Comparing Releases
-> 
-> You can use the `--from` and `--to` options to generate release notes comparing two different releases. For example, to see what changed between v1.0.0 and v1.1.0, you could use `kodrdriv release --from v1.0.0 --to v1.1.0`. This is particularly useful for creating detailed changelogs when preparing release documentation.
-
-### Release Command Options
-
-- `--from <from>`: Branch or reference to generate release notes from (default: 'main')
-- `--to <to>`: Branch or reference to generate release notes to (default: 'HEAD')
-- `--context <context>`: Provide additional context (as a string or file path) to guide the release notes generation. This context is included in the prompt sent to the AI and can be used to specify the purpose, theme, or any special considerations for the release.
-- `--message-limit <messageLimit>`: Limit the number of recent commit messages (from git log) to include in the release notes prompt (default: 10). Reducing this number can make the summary more focused, while increasing it provides broader historical context.
-
-## Publish Command
-
-Automate the entire release process, from dependency updates to GitHub release creation:
-
-```bash
-kodrdriv publish
-```
-
-The `publish` command orchestrates a comprehensive release workflow, designed to ensure a safe and consistent release process. Here's what it does:
-
-1. **Dependency Management**: If a `pnpm-workspace.yaml` file is present, it's temporarily renamed to switch from workspace dependencies to registry versions. It then runs `pnpm update --latest` to ensure dependencies are up to date. You can configure specific dependency patterns to update instead of updating all dependencies using the `dependencyUpdatePatterns` configuration option.
-
-2. **Pre-flight Checks**: Before committing any changes, it runs the `prepublishOnly` script from your `package.json`. This script should contain your project's pre-flight checks (e.g., `clean`, `lint`, `build`, `test`) to ensure the project is in a good state. **Note**: A `prepublishOnly` script is required in your `package.json` - the publish command will fail if this script is not present.
-
-3. **Release Commit**: If there are changes to `package.json` or `pnpm-lock.yaml`, it creates an intelligent commit message for the dependency updates.
-
-4. **Version Bump**: It automatically bumps the patch version of your project.
-
-5. **Release Notes**: It generates release notes based on the recent changes and saves them to `RELEASE_NOTES.md`.
-
-6. **Pull Request Automation**:
-   - It pushes the changes and tags to the origin.
-   - It creates a new pull request for the release.
-   - It waits for all status checks on the pull request to pass.
-   - Once checks are complete, it automatically merges the pull request using the configured merge method (default: squash).
-
-7. **GitHub Release**: After the PR is merged, it checks out the `main` branch, pulls the latest changes, and creates a new GitHub release with the tag and release notes.
-
-8. **New Release Branch**: Finally, it creates and pushes a new release branch for the next version (e.g., `release/0.0.5`).
-
-This command is designed for repositories that follow a pull-request-based release workflow with required status checks. It streamlines the process, reducing manual steps and potential for error.
-
-### Publish Command Options
-
-- `--merge-method <method>`: Method to merge pull requests during the publish process (default: 'squash')
-  - Available methods: 'merge', 'squash', 'rebase'
-
-## Link Command
-
-Manage pnpm workspace links for local development with sibling projects:
-
-```bash
-kodrdriv link
-```
-
-The `link` command automates the creation and management of pnpm workspace configurations for local development. It scans your project's dependencies and automatically discovers matching sibling packages in configured scope directories, then updates your `pnpm-workspace.yaml` file to link them for local development.
-
-This is particularly useful when working with monorepos or related packages where you want to use local versions of dependencies instead of published registry versions during development.
-
-### Link Command Options
-
-- `--scope-roots <scopeRoots>`: JSON mapping of scopes to root directories for package discovery
-  - **Format**: `'{"@scope": "path", "@another": "path"}'`
-  - **Example**: `'{"@company": "../", "@myorg": "../../packages/"}'`
-  - **Required**: At least one scope mapping must be provided
-- `--workspace-file <workspaceFile>`: Path to the workspace file to create/update (default: 'pnpm-workspace.yaml')
-
-For detailed information about each command, including advanced configuration options and use cases, see the complete [Commands Documentation](commands.md).