https://github.com/qwertic/crrl
A friendly CLI tool for your .cursorrules files
https://github.com/qwertic/crrl
cursor cursorai npm-package
Last synced: 8 months ago
JSON representation
A friendly CLI tool for your .cursorrules files
- Host: GitHub
- URL: https://github.com/qwertic/crrl
- Owner: Qwertic
- License: mit
- Created: 2024-09-10T15:00:46.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-30T14:49:10.000Z (over 1 year ago)
- Last Synced: 2025-02-02T08:12:13.621Z (over 1 year ago)
- Topics: cursor, cursorai, npm-package
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/crrl
- Size: 103 KB
- Stars: 17
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# crrl - Cursor Rules CLI
`crrl` is a command-line interface (CLI) tool designed to fetch and save `.cursorrules` files from a GitHub repository or a remote URL. It simplifies the process of managing cursor rules for your projects.
## Features
- Fetch `.cursorrules` files from a specific [GitHub repository](https://github.com/Qwertic/cursorrules) that seerves as a remote storage for cursor rules
- Download `.cursorrules` files from a remote URL
- Interactive directory selection when fetching from the GitHub repository
- Save `.cursorrules` files to a specified local directory
## Installation
To install `crrl`, you need Node.js(^20) and npm (or pnpm) installed on your system. Then, you can install it globally using:
```bash
npm install -g crrl
```
## Usage
To use `crrl`, run the following command:
```bash
crrl
```
You can also use it to download a cursor rule by specifying the remote url:
```bash
crrl -u -d
```
## License
This project is licensed under the MIT License. See the [LICENSE](/LICENSE.md) file for more details.