Note: If you haven't already, you'll have to create an account and set up billing.
Set the key so ai-shell can use it:
ai-shell config set OPENAI_KEY=<your token>
This will create a .ai-shell file in your home directory.
Usage
ai <prompt>
For example:
ai list all log files
Then you will get an output like this, where you can choose to run the suggested command, revise the command via a prompt, or cancel:
◇ Your script:
│
│ find . -name "*.log"
│
◇ Explanation:
│
│ 1. Searches for all files with the extension ".log"in the current directory and any subdirectories.
│
◆ Run this script?
│ ● ✅ Yes (Lets go!)
│ ○ 📝 Revise
│ ○ ❌ Cancel
└
Special characters
Note that some shells handle certain characters like the ? or * or things that look like file paths specially. If you are getting strange behaviors, you can wrap the prompt in quotes to avoid issues, like below:
Some users are reporting a 429 from OpenAI. This is due to incorrect billing setup or excessive quota usage. Please follow this guide to fix it.
You can activate billing at this link. Make sure to add a payment method if not under an active grant from OpenAI.
Motivation
I am not a bash wizard, and am dying for access to the copilot CLI, and got impatient.
Contributing
If you want to help fix a bug or implement a feature in Issues (tip: look out for the help wanted label), checkout the Contribution Guide to learn how to setup the project.
Credit
Thanks to Github Copilot for their amazing tools and the idea for this
Thanks to Hassan and his work on aicommits which inspired the workflow and some parts of the code and flows
Community
Come join the Builder.io discord and chat with us in the #ai-shell-general room
0.1.5
Improve error messaging UX, again x3
FAQs
A CLI that converts natural language to shell commands.
The npm package @builder.io/ai-shell receives a total of 40 weekly downloads. As such, @builder.io/ai-shell popularity was classified as not popular.
We found that @builder.io/ai-shell demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago.It has 0 open source maintainers collaborating on the project.
Package last updated on 09 Apr 2023
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.