Skip to content
This repository was archived by the owner on Feb 5, 2026. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 17 additions & 43 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,25 +12,18 @@ A command-line interface tool for installing and managing Cursor AI rules in you

## Installation

We recommend adding it to your project:

Yarn:

```bash
yarn add -D @multiverse-io/cari
```

npm:
We recommend installing globally:

```bash
npm install --save-dev @multiverse-io/cari
npm install -g @multiverse-io/cari
```

If you like you can install globally with:
## The structure of an AI Rules repository

```bash
npm install -g @multiverse-io/cari
```
- Cari works by taking rules from your central AI Rules repository and installing them to your project
- The only requirement for a central rules repository is that it contains a top-level `rules` directory
- Within the rules directory you should have your `*.mdc` rules files
- These files can be nested within folders to help you organise them by category

### Initialize AI Rules

Expand All @@ -39,37 +32,27 @@ Initialize AI rules in your project:
Yarn:

```bash
yarn run cari init # Or `cari init` if installed globally
```

npm:

```bash
npx cari init # Or `cari init` if installed globally
cari init
```

This command will:

1. Clone the AI rules repository in `~/.cari` if it doesn't exist
1. Clone the AI rules repository(s) in `~/.cari` if it doesn't exist
2. Find all available rule files
3. Allow you to select which rules to include
4. Create a configuration file (.cari.yaml) in your project
5. Copy the selected rule files to your project

![Init Demo](assets/init.gif)

### Update AI Rules

Update the AI rules in your project:

Yarn:

```bash
yarn run cari update # Or `cari update` if installed globally
```

npm:

```bash
npx cari update # Or `cari update` if installed globally
cari update
```

This command will:
Expand All @@ -79,30 +62,21 @@ This command will:
3. Copy the latest version of those rules to your project
4. Ask if you want to include any new central rules it finds

![Update Demo](assets/update.gif)

## For Contributors

### Requirements

- Node.js >= 14.0.0
- Yarn >= 4.1.1 (recommended package manager)
- Yarn >= 4.1.1

### Initial setup

```bash
# Clone the repository
git clone git@github.com:Multiverse-io/cari.git
cd cari

# Set up GitHub authentication
# 1. Create a GitHub Personal Access Token (PAT):
# - Go to GitHub.com → Settings → Developer Settings → Personal Access Tokens → Tokens (classic)
# - Generate a new token with scopes: read:packages, repo
# 2. Set the token as an environment variable:
export GITHUB_TOKEN=your_github_token_here
# Or create a .env file in the project root with:
# GITHUB_TOKEN=your_github_token_here

# Install dependencies
yarn install
```

Expand All @@ -111,8 +85,8 @@ yarn install
```bash
# Run in development mode
yarn dev
yarn dev init # Run the init command
yarn dev update # Run the update command
yarn dev init
yarn dev update

# Build the project
yarn build
Expand Down
Binary file added assets/init.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/update.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.