Installations
npm install asktocmd
Developer Guide
Typescript
No
Module System
ESM
Min. Node Version
>=14.0.0
Node Version
20.12.2
NPM Version
10.8.2
Score
50.4
Supply Chain
95.8
Quality
77.9
Maintenance
100
Vulnerability
99.6
License
Releases
Unable to fetch releases
Contributors
Unable to fetch Contributors
Languages
JavaScript (100%)
Developer
21prnv
Download Statistics
Total Downloads
222
Last Day
3
Last Week
7
Last Month
20
Last Year
222
GitHub Statistics
3 Stars
18 Commits
1 Watching
1 Branches
1 Contributors
Package Meta Information
Latest Version
1.0.7
Package Id
asktocmd@1.0.7
Unpacked Size
25.56 kB
Size
9.96 kB
File Count
5
NPM Version
10.8.2
Node Version
20.12.2
Publised On
21 Oct 2024
Total Downloads
Cumulative downloads
Total Downloads
222
Last day
0%
3
Compared to previous day
Last week
75%
7
Compared to previous week
Last month
-48.7%
20
Compared to previous month
Last year
0%
222
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dev Dependencies
1
asktocmd 🤖
Did you forget your command-line commands? Don't worry! Now you can directly ask asktocmd, your AI-powered CLI helper. Ask about any command, operation, or CLI-related query, and get instant, intelligent responses powered by Google's Gemini AI.
🚀 Quick Start
1# Install globally 2npm install -g asktocmd 3 4# Set up your API key (get it from https://aistudio.google.com/app/apikey) 5asktocmd set-api-key YOUR_GEMINI_API_KEY 6 7# Start asking questions! 8asktocmd "How do I list all files in a directory?"
🌟 Features
- 🤖 AI-powered responses to command-line queries using Google's Gemini AI
- 💬 Interactive mode for continuous questioning
- 🎨 Beautiful terminal output with syntax highlighting
- 📝 Markdown formatting for easy readability
- 🚀 Fast and efficient responses
- 📚 Comprehensive command-line knowledge
- 🌐 Works across different operating systems
📦 Installation
To install asktocmd globally:
1npm install -g asktocmd
Verify the installation:
1asktocmd --version
🔑 API Key Setup
asktocmd requires a Gemini API key to function. Here's how to get started:
-
Get your API key:
- Visit Google AI Studio to create your API key
- If you're new, you'll need to sign in with your Google account
- Click on "Create API key" and copy your new key
-
Set up the key using one of these methods:
a. Using the CLI command (recommended):
1asktocmd set-api-key YOUR_GEMINI_API_KEY
b. Manual configuration:
- The key is stored in
~/.asktocmd-config.json
- You can edit this file directly if needed
- The key is stored in
🖥 Usage
asktocmd offers two modes of operation:
1. Direct Query Mode
Perfect for quick, one-off questions:
1# Basic usage 2asktocmd "How do I find the largest files in a directory?" 3 4# Complex queries 5asktocmd "How do I use grep to search for multiple patterns?"
2. Interactive Mode
Great for multiple questions or learning sessions:
1asktocmd -i
This starts an interactive session where you can:
- Ask multiple questions
- Get immediate responses
- Type 'exit' to quit
📋 Example Queries
1# File operations 2asktocmd "How do I recursively search for files?" 3 4# Process management 5asktocmd "How do I kill a process using a specific port?" 6 7# System information 8asktocmd "How can I check system resource usage?"
🛠 Advanced Usage
1# Get help 2asktocmd --help 3 4# Check version 5asktocmd --version 6 7# Update API key 8asktocmd set-api-key NEW_API_KEY
🤝 Contributing
Contributions are welcome! Here's how you can help:
- Fork the repository
- Create your feature branch:
git checkout -b feature/new-feature
- Commit your changes:
git commit -am 'Add new feature'
- Push to the branch:
git push origin feature/new-feature
- Submit a pull request
🐛 Bug Reports
Found a bug? Please report it on our issues page with:
- A clear description of the issue
- Steps to reproduce
- Expected vs actual behavior
📜 License
This project is licensed under the MIT License - see the LICENSE file for details.
👨💻 Author
Pranav
💖 Support
If you find asktocmd helpful:
- ⭐ Give it a star on GitHub
- 📢 Share it with your fellow developers
- 🐦 Follow the creator on Twitter for updates
🙏 Acknowledgments
- Google Gemini AI for powering the responses
- The open-source community for inspiration and support
Happy command-line querying! 🎉
No vulnerabilities found.
No security vulnerabilities found.