scrycli
v0.1.0
Published
AI-powered CLI for detecting and fixing code errors.
Downloads
57
Maintainers
Readme
SCRYCLI
An AI-powered CLI tool for detecting and fixing code errors with a beautiful terminal interface.
🚀 Features
- Beautiful Terminal UI: Built with React and Ink for a modern CLI experience
- AI-Powered Analysis: Detects and analyzes code errors using AI
- Interactive Interface: User-friendly prompts and real-time feedback
- Cross-Platform: Works on Windows, macOS, and Linux
📦 Installation
npm install -g scrycliOr install locally:
npm install scrycli🎯 Usage
Run the CLI tool:
scrycliThe tool will present you with an interactive interface to:
- Select or input a file path
- Analyze the code for errors
- Display results with AI-powered insights
🛠️ Development
Prerequisites
- Node.js (v16 or higher)
- npm or yarn
Setup
- Clone the repository:
git clone <repository-url>
cd scrycli- Install dependencies:
npm install- Build the project:
npm run build- Run in development mode:
npm run devProject Structure
src/
├── bin/ # CLI entry point
├── ui/ # React components
│ ├── App.tsx # Main application
│ ├── Welcome.tsx # Welcome screen
│ └── Auth.tsx # Authentication (if needed)🧰 Built With
- React - UI framework
- Ink - React for CLI
- TypeScript - Type safety
- Commander - CLI argument parsing
📝 Scripts
npm run build- Build the TypeScript projectnpm run dev- Build and run the CLInpm test- Run tests (not implemented yet)
🤝 Contributing
- Fork the project
- Create a feature branch (
git checkout -b feature/AmazingFeature) - Commit your changes (
git commit -m 'Add some AmazingFeature') - Push to the branch (
git push origin feature/AmazingFeature) - Open a Pull Request
📄 License
This project is licensed under the ISC License.
👨💻 Author
Sanskar - @sanskarmishra479
Made with ❤️ for the developer community
