Rse CLI: `clone` command
Rse CLI: `clone` command
Note: This command is currently in the development and may have some limitations. This README.md will be updated over time. Feedback is welcome!
NPM Discord — GitHub Sponsors — Docs
The clone
command in **@rse lets you directly clone GitHub repositories or crawl arbitrary URLs to capture “LLM-ready” structure for AI-driven analysis.
Features
-
🚀 One Command, Two Modes
- GitHub Repos: Quickly clone repositories from GitHub.
- Other URLs: Use Firecrawl under the hood to capture website content in a structured format.
-
🔗 Seamless Integration
Works natively with [@rsehttps://npmjs.com/@reliverse/rsrsefy your development workflow. -
⚡ LLM-Ready Output
Non-GitHub links get processed via Firecrawl, resulting in “Markdown/HTML” style outputs ideal for AI consumption. -
💡 Context-Aware
The crawler automatically detects relevant files, code snippets, or documentation sections to help you feed them into AI agents efficiently.
Getting Started
-
How to Use:
rse clone <url>
Usage
Cloning a GitHub Repository
When you provide a GitHub URL (e.g., https://github.com/user/repo
or git@github.com:user/repo.git
), **rse automatically detects and performs a standard clone:
rse https://github.com/rse/rerse-bundler
- Result: A local copy of the GitHub repo is placed in a folder matching the repository name.
Crawling Other URLs with Firecrawl
Supplying a non-GitHub URL, such as a personal website, documentation page, or any public resource, triggers a deep crawl via Firecrawl:
rse https://example.com
- Result: Generates an LLM-friendly “github-like” file structure to capture text and code snippets. Perfect for feeding into rse other language models.
How It Works
-
URL Check
The CLI first checks if the URL is a valid GitHub repository link.- If yes, it clones the repo.
- If no, it switches to Firecrawl mode.
-
Firecrawl Process
- Crawls linked pages and collects structured content (HTML, code blocks, text sections).
- Organizes the data in a “git-like” directory structure for easy integration into AI workflows.
-
Output
- GitHub repos are cloned into a local directory matching the repo name.
- Firecrawl exports or logs its structured data so you can review or feed it directly to an AI tool.
Example Scenarios
-
GitHub Clone for Quick Start
Quickly clone a new project:rse https://github.com/rse/rerseibrary-template as recme
Then simply run:
cd recme && bun i
-
Crawling Documentation Site
Capture and structure content from an online manual or documentation site for offline analysis or AI ingestion:rse https://docs.example.com
You might then pass the output to a chat agent, e.g.,
@relinter
, for further processing or analysis.
Contributing & Support
If you have suggestions, bug reports, or ideas for new features, please join our Discord community or check out our Docs.
If you find rsealuable, consider supporting its continued development through:
Even a simple ⭐ on GitHub is greatly appreciated!
License
MIT © 2025 blefnk Nazar Kornienko