Skip to content
This repository was archived by the owner on Feb 5, 2026. It is now read-only.

Commit 696d679

Browse files
committed
Update readme with installation and usage instructions
1 parent 904e993 commit 696d679

File tree

1 file changed

+43
-57
lines changed

1 file changed

+43
-57
lines changed

README.md

Lines changed: 43 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -12,81 +12,87 @@ A command-line interface tool for installing and managing Cursor AI rules in you
1212

1313
## Installation
1414

15-
```bash
16-
# Clone the repository
17-
git clone git@github.com:Multiverse-io/cari.git
18-
cd cari
19-
20-
# Install dependencies
21-
yarn install
22-
```
15+
We recommend adding it to your project:
2316

24-
## Development
17+
Yarn:
2518

2619
```bash
27-
# Run in development mode
28-
yarn dev
29-
yarn dev init # Run the init command
30-
yarn dev update # Run the update command
31-
32-
# Build the project
33-
yarn build
34-
35-
# Run the built version
36-
yarn start
20+
yarn add -D @multiverse-io/cari
3721
```
3822

39-
## Global Installation
40-
41-
To install the CLI globally on your system:
23+
npm:
4224

4325
```bash
44-
# Build the project first
45-
yarn build
26+
npm install --dev @multiverse-io/cari
27+
```
4628

47-
# Install globally using npm
48-
npm install -g .
29+
If you like you can install globally with:
4930

50-
# Now you can run the command from anywhere
51-
cari
31+
```bash
32+
npm install -g @multiverse-io/cari
5233
```
5334

54-
## Usage
55-
5635
### Initialize AI Rules
5736

5837
Initialize AI rules in your project:
5938

6039
```bash
61-
cari init
40+
yarn run cari init # Or `cari init` if installed globally
6241
```
6342

6443
This command will:
65-
1. Clone the AI rules repository if it doesn't exist
44+
1. Clone the AI rules repository in `~/.cari` if it doesn't exist
6645
2. Find all available rule files
6746
3. Allow you to select which rules to include
68-
4. Create a configuration file (.ari.yaml)
47+
4. Create a configuration file (.cari.yaml) in your project
6948
5. Copy the selected rule files to your project
7049

7150
### Update AI Rules
7251

7352
Update the AI rules in your project:
7453

7554
```bash
76-
cari update
55+
yarn run cari update # Or `cari update` if installed globally
7756
```
7857

7958
This command will:
8059
1. Pull the latest changes from the AI rules repository
81-
2. Check your configuration file (.ari.yaml) for included rules
60+
2. Check your configuration file (.cari.yaml) for included rules
8261
3. Copy the latest version of those rules to your project
62+
4. Ask if you want to include any new central rules it finds
63+
64+
## For Contributors
8365

84-
## Requirements
66+
### Requirements
8567

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

89-
## Development
71+
### Initial setup
72+
73+
```bash
74+
# Clone the repository
75+
git clone git@github.com:Multiverse-io/cari.git
76+
cd cari
77+
78+
# Install dependencies
79+
yarn install
80+
```
81+
82+
### Development
83+
84+
```bash
85+
# Run in development mode
86+
yarn dev
87+
yarn dev init # Run the init command
88+
yarn dev update # Run the update command
89+
90+
# Build the project
91+
yarn build
92+
93+
# Run the built version
94+
yarn start
95+
```
9096

9197
### Testing
9298

@@ -101,26 +107,6 @@ yarn test:watch
101107
yarn test:coverage
102108
```
103109

104-
### Project Structure
105-
106-
```
107-
cursor-ai-rules-installer/
108-
├── src/
109-
│ ├── commands/ # CLI commands implementation
110-
│ └── index.ts # Main CLI entry point
111-
├── dist/ # Compiled JavaScript files
112-
├── package.json # Project configuration
113-
└── README.md # This file
114-
```
115-
116-
## Contributing
117-
118-
1. Fork the repository
119-
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
120-
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
121-
4. Push to the branch (`git push origin feature/amazing-feature`)
122-
5. Open a Pull Request
123-
124110
## Author
125111

126112
Tim Gent

0 commit comments

Comments
 (0)