Snitch CLI

Ask the CIC agent questions directly from your terminal

A lightweight command-line interface tool that lets you interact with the CIC (Coding in Color) agent right from your terminal, featuring a beautiful typewriter-style response animation.

Features

• 🚀 Simple CLI - Ask questions with a single command
• ✨ Typewriter Effect - Beautiful letter-by-letter response streaming
• 🎨 Colorized Output - Enhanced readability with styled text
• 🛡️ Error Handling - Graceful error messages and responses

Installation

Prerequisites

• Node.js >= 20.x
• npm

Install

Simply install the package globally:

npm install -g snitch-cli

That's it! You're ready to start using Snitch.

Usage

Basic Query

snitch "What are the latest check-ins?"

Examples

# Ask about student information
snitch "How many students are in Coding in Color?"

# Query check-in data
snitch "Show me recent check-ins"

# Get skills information
snitch "What skills do students have?"

Project Structure

snitch-cli/
├── bin/
│   └── snitch.js          # CLI entry point
├── src/
│   └── api.js             # API module
└── package.json           # Package metadata

Dependencies

• axios (^1.13.5) - HTTP client for API requests
• chalk (^4.1.2) - Terminal string styling
• commander (^14.0.3) - Command-line interface framework

Customization

Adjust Typewriter Speed

You can modify the response animation speed by editing the delay in the source code.

Change Colors

Customize the terminal colors by modifying the chalk styling in the source files.

Troubleshooting

Command Not Found

If snitch command is not found after installation, try reinstalling globally:

npm install -g snitch-cli

Need Help?

Run the help command to see available options:

snitch --help

License

MIT

Author

Mazamesso Meba

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Version History

• 1.0.0 - Initial release with typewriter effect and basic functionality

Future Enhancements

• [ ] Interactive mode for continuous conversations
• [ ] Save conversation history
• [ ] Custom response formatting options
• [ ] Offline mode support