deepan-cli
v1.0.4
Published
Deepan AI CLI using direct API
Readme
Deepan CLI
A powerful command-line interface that brings Deepan AI directly to your terminal. Experience intelligent conversations with AI without leaving your development environment.
Features
- Interactive AI Chat: Engage in real-time conversations with Deepan AI
- Beautiful CLI Interface: Stunning ASCII art banner with gradient colors
- Intelligent Responses: Get insightful, precise, and helpful answers
- Simple Commands: Easy-to-use interface with intuitive commands
- Cross-Platform: Works on Windows, macOS, and Linux
- Lightweight: Fast startup and minimal resource usage
Installation
Install Deepan CLI globally using npm:
npm install -g deepan-cliUsage
Starting the CLI
Once installed, simply run:
deepanaiThis will display the welcome banner and start an interactive session.
Basic Commands
- Ask questions: Simply type your question and press Enter
- Exit: Use any of these commands to exit:
exitquitbye
Example Session
$ deepanai
____ ____ _ ___
| _ \ ___ ___ _ __ __ _ _ __ / ___| | |_ _|
| | | |/ _ \/ _ \ '_ \ / _` | '_ \ | | | | | |
| |_| | __/ __/ |_) | (_| | | | | | |___| |___ | |
|____/ \___|\___| .__/ \__,_|_| |_| \____|_____|___|
|_|
Welcome to Deepan AI CLI!
Ask Deepan AI: What is machine learning?
🤖 Deepan AI:
Machine learning is a subset of artificial intelligence that enables
systems to learn and improve from experience without being explicitly
programmed for every task...
Ask Deepan AI: bye
🤖 Deepan AI:
Goodbye! Have a great day!Technical Details
Requirements
- Node.js: Version 14.0.0 or higher
- npm: Version 6.0.0 or higher
- Internet Connection: Required for AI responses
Dependencies
The CLI uses several key libraries:
readline: For interactive command-line interfaceaxios: For API requests to Deepan AIfiglet: For ASCII art text generationgradient-string: For beautiful colored terminal output
Customization
Gradient Themes
The CLI supports multiple gradient themes for the banner. You can modify the gradient in the source code:
atlas(default)rainbowpastelmorningsummerteenmind
Troubleshooting
Common Issues
Installation fails with permission errors:
# Try installing with sudo (macOS/Linux)
sudo npm install -g deepan-cli
# Or use npx for one-time usage
npx deepan-cliCommand not found after installation:
- Ensure your npm global bin directory is in your PATH
- Try restarting your terminal
- Check installation with
npm list -g deepan-cli
API connection issues:
- Check your internet connection
- Verify the API service is available
- Contact support if issues persist
Contributing
Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.
Development Setup
- Clone the repository
- Install dependencies:
npm install - Make your changes
- Add the .env file then add your API credentials
- Test locally:
node cli.js - Submit a pull request
Support
- Issues: GitHub Issues
- Email: [email protected]
- Documentation: Full Documentation
Acknowledgments
- Built with Node.js and powered by advanced AI technology
- Special thanks to the open-source community for the amazing libraries used
- Inspired by the need for accessible AI tools for developers
Made with ❤️ by Deepan
Bringing AI to your fingertips, one command at a time.
