ajisai

# ajisai

[![ci](https://github.com/sushichan044/ajisai/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/sushichan044/ajisai/actions/workflows/ci.yml)
[![Go Reference](https://pkg.go.dev/badge/github.com/sushichan044/ajisai.svg)](https://pkg.go.dev/github.com/sushichan044/ajisai)
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/sushichan044/ajisai)

**Ajisai** is a simple preset manager for AI Coding Agents.

You can package rule and prompt configurations and reuse them across multiple projects.

- [ajisai](#ajisai)
  - [Features](#features)
  - [Supported AI Coding Agents](#supported-ai-coding-agents)
  - [Installation](#installation)
  - [Quick Start](#quick-start)
    - [1. Write Config](#1-write-config)
    - [2. Write your rules](#2-write-your-rules)
    - [3. Deploy your rules](#3-deploy-your-rules)
  - [User Guide](#user-guide)
    - [Defining and Importing Local Preset Packages](#defining-and-importing-local-preset-packages)
      - [1. Define Your Package's Exports](#1-define-your-packages-exports)
      - [2. Structure Your Rule and Prompt Files](#2-structure-your-rule-and-prompt-files)
      - [3. Import the Local Package into Your Workspace](#3-import-the-local-package-into-your-workspace)
    - [Sharing and Exporting Packages via Git](#sharing-and-exporting-packages-via-git)
    - [Import Preset Packages via Git](#import-preset-packages-via-git)
    - [Tip: Special `default` preset](#tip-special-default-preset)
  - [File Reference](#file-reference)
    - [Rule File (`*.md`)](#rule-file-md)
    - [Prompt File (`*.md`)](#prompt-file-md)
  - [Config Reference](#config-reference)
  - [Contributing](#contributing)

## Features

- **Interoperability 🤖** - Simply by writing rules and prompts in a single format, they are automatically deployed to the appropriate format and directory for each supported AI Coding Agent.
- **Reuse 📤** - You can import AI presets not only from local directories but also from remote Git repositories.
- **Gradual Introduction ⏩**: Enables adoption without conflicting with existing rules.

## Supported AI Coding Agents

- [x] GitHub Copilot in VSCode
  - Update VSCode to 1.100 or later
  - Use latest GitHub Copilot extension
  - **Make sure you set `chat.promptFiles` to true in project or user settings.**
  - `mode` and `tools` property in prompt file is not supported yet
  - Currently no support for using GitHub Copilot in other editors, IDEs.
- [x] Cursor
- [x] Windsurf
  - Update Windsurf to Wave 8 or later
- [ ] Cline
- [ ] Roo Code
- [x] Devin (Maybe partial support)
  - Devin can pull rules from the Cursor format, so enabling Cursor integration and run `ajisai apply` in Devin's environment would be effective.
    - <https://docs.devin.ai/onboard-devin/knowledge-onboarding#knowledge-101>

## Installation

<details>
  <summary>homebrew</summary>

```bash
brew install sushichan044/tap/ajisai
```

</details>

<details>
  <summary>go install (requires Go 1.21+) </summary>

```bash
go install github.com/sushichan044/ajisai@latest
```

> [!WARNING]
> Because `ajisai` embeds its revision information at **build time**, the **revision** isn't displayed correctly when installed using `go install`.

</details>

<details>
  <summary>mise</summary>

```toml
# mise.toml
[tools]
"go:github.com/sushichan044/ajisai" = "latest"
```

> [!WARNING]
> Because `ajisai` embeds its revision information at **build time**, the **revision** isn't displayed correctly when installed using `go install`.

</details>

<details>
  <summary>manual</summary>

Download the latest release from the [GitHub releases page](https://github.com/sushichan044/ajisai/releases).

</details>

## Quick Start

`ajisai` is controlled via CLI.

The default configuration file is `ajisai.yml` or `ajisai.yaml` in the current directory, but a different file can be specified using the `--config` (or `-c`) flag.

### 1. Write Config

```yaml
workspace:
  imports:
    local_rules:
      type: local
      path: "./.ai"
      include:
      - default # See Special `default` preset docs for details
  integrations:
    cursor:
      enabled: true
    github-copilot:
      enabled: true
    windsurf:
      enabled: true
```

### 2. Write your rules

Write your rules under `.ai/rules/**/*.md`.

Refer [Rule file - File Reference](#rule-file-md) for supported syntax and structure.

### 3. Deploy your rules

Just run `ajisai apply`.

## User Guide

In ajisai, instructions for AI Coding Agents are handled using the following units:

- **Preset**: A collection of specific Rules and reusable prompts.
- **Package**: A unit for exporting multiple presets.

When reusing packaged instructions, you specify the package to use and the presets to include from it.

### Defining and Importing Local Preset Packages

You can define reusable preset packages locally, for example, within a dedicated directory in your project (like `.ai/`) or in a separate local directory. This same package definition approach is f

... (truncated)