bashio 2.0.0 → 2.1.1

package/LICENSE

@@ -1,21 +1,217 @@
-MIT License
-
-Copyright (c) 2025 Vranda Garg
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no theory of
+      liability, whether in contract, strict liability, or tort
+      (including negligence or otherwise) arising in any way out of
+      the use or inability to use the Work (even if such Holder or other
+      party has been advised of the possibility of such damages), shall
+      any Contributor be liable to You for damages, including any direct,
+      indirect, special, incidental, or consequential damages of any
+      character arising as a result of this License or out of the use or
+      inability to use the Work (including but not limited to damages for
+      loss of goodwill, work stoppage, computer failure or malfunction, or
+      any and all other commercial damages or losses), even if such
+      Contributor has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 Vranda Garg
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+================================================================================
+
+                            ADDITIONAL TERMS
+
+If you use, modify, or distribute this project or any part of it, you MUST:
+
+   1. Attribution: Give clear and visible credit to Vranda Garg as the
+      original author.
+
+   2. Link Back: Include a link to the original repository:
+      https://github.com/VrandaaGarg/bashio
+
+These additional terms are provided under Section 4(b) of the Apache License 2.0,
+which permits the addition of attribution notices.

package/README.md

@@ -1,67 +1,53 @@
-# Bashio
+<!-- SEO: Bashio - AI CLI Tool | Natural Language to Shell Commands -->
+<!-- Transform plain English into shell commands. Supports Claude, OpenAI, GitHub Copilot, Ollama. -->
 
-> Natural language to shell commands. Stop Googling, start doing.
+<p align="center">
+  <a href="https://github.com/VrandaaGarg/bashio">
+    <img src="https://res.cloudinary.com/dyetf2h9n/image/upload/v1769023957/Natural_language_to_shell_commands._Stop_Googling_start_doing._1_u8e0qd.png" alt="Bashio" width="100%" />
+  </a>
+</p>
 
-```bash
-npm i -g bashio
-```
+<p align="center">
+  <a href="https://www.npmjs.com/package/bashio"><img src="https://img.shields.io/npm/v/bashio.svg" alt="npm" /></a>
+  <a href="https://github.com/VrandaaGarg/bashio/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg" alt="License" /></a>
+  <a href="https://github.com/VrandaaGarg/bashio"><img src="https://img.shields.io/github/stars/VrandaaGarg/bashio?style=social" alt="Stars" /></a>
+</p>
 
 ---
 
-## What is Bashio?
-
-Bashio is an AI-powered CLI tool that converts plain English into shell commands. Instead of searching for the right syntax, just describe what you want to do.
+## Quick Start
 
 ```bash
-$ b find all files larger than 100mb and delete them
-```
-```
-  > find . -size +100M -type f -delete
-
-  ? Execute? (y/n/e/c/edit)
+npm i -g bashio        # Install globally
+b --auth               # Setup your AI provider
+b show disk usage      # Start using!
 ```
 
-You review the command, then choose to execute, edit, or cancel. Simple.
+Requires Node.js 20.12.0+
 
 ---
 
-## Getting Started
+## What is Bashio?
 
-### 1. Install
+Bashio converts plain English into shell commands. Describe what you want, review the command, then execute.
 
 ```bash
-npm i -g bashio
+$ b find all files larger than 100mb and delete them
 ```
-
-Requires Node.js 20.12.0 or higher.
-
-### 2. Setup your AI provider
-
-```bash
-b --auth
 ```
+  > find . -size +100M -type f -delete
 
-Choose from multiple providers:
-- **Claude** (Anthropic) - API Key or Pro/Max subscription
-- **OpenAI** (ChatGPT) - API Key or Plus/Pro subscription
-- **GitHub Copilot** - Free with Copilot subscription
-- **Ollama** - Free, runs locally
-- **OpenRouter** - Pay-per-use, multiple models
-
-### 3. Start using it
-
-```bash
-b show disk usage sorted by size
+  ? Execute? (y/n/e/c/edit)
 ```
 
-That's it. You're ready to go.
+**Options:** `y` execute · `n` cancel · `e` explain · `c` copy · `edit` modify
 
 ---
 
 ## Examples
 
 ```bash
-# File operations
+# Files
 b find all javascript files modified today
 b delete all node_modules folders recursively
 b compress all png images in this folder
@@ -74,155 +60,105 @@ b show commits from last week by john
 b kill whatever is running on port 3000
 b what is my public ip address
 b list all running docker containers
-
-# Network
-b download this url and save as data.json
 ```
 
 ---
 
-## Interactive Chat Mode
+## Chat Mode
 
-Start an interactive AI chat session for more complex conversations:
+Full-screen AI chat with streaming responses:
 
 ```bash
 b --chat
 ```
 
-**Chat Features:**
-- Full-screen TUI with streaming responses
-- Session management (save, load, switch sessions)
-- Slash commands for quick actions
-- Theme customization
-- Model switching mid-conversation
+**Features:** Session history · Slash commands · Themes · Model switching
 
-**Keyboard Shortcuts (in chat):**
 | Shortcut | Action |
 |----------|--------|
-| `Ctrl+M` or `Ctrl+P` | Switch model |
-| `Ctrl+O` | Open session picker |
+| `Ctrl+P` | Switch model |
+| `Ctrl+O` | Open sessions |
 | `Ctrl+T` | Change theme |
-| `Ctrl+C` | Exit chat |
-
-**Slash Commands:**
-| Command | Action |
-|---------|--------|
-| `/models` | Switch AI model |
-| `/sessions` | Browse chat sessions |
-| `/theme` | Change color theme |
-| `/new` | Start new chat session |
-| `/clear` | Clear current chat |
-| `/exit` | Exit chat |
-
----
-
-## Confirmation Options
-
-When a command is generated, you can:
-
-| Key | Action |
-|-----|--------|
-| `y` or Enter | Execute the command |
-| `n` | Cancel |
-| `e` | Explain what the command does |
-| `c` | Copy to clipboard |
-| `edit` | Edit the command before running |
+| `Ctrl+C` | Exit |
 
 ---
 
 ## Shortcuts
 
-Save commands you use frequently as shortcuts with placeholders.
-
-### Create a shortcut
+Save frequently used commands with placeholders:
 
 ```bash
-# Interactive
-b --add-shortcut
-
-# One-liner
 b --add-shortcut killport "lsof -ti:{{port}} | xargs kill -9" port
-```
-
-### Use it
-
-```bash
-b killport 3000
-```
-```
-  [shortcut: killport]
-  > lsof -ti:3000 | xargs kill -9
-
-  ? Execute? (y/n/e/c/edit)
-```
-
-### Manage shortcuts
-
-```bash
-b --shortcuts              # List all
-b --edit-shortcuts         # Edit in your editor
-b --remove-shortcut name   # Delete one
+b killport 3000    # Uses the shortcut
 ```
 
 ---
 
 ## AI Providers
 
-Configure with `b --auth`. Supported providers:
+Configure with `b --auth`:
 
-| Provider | Auth Method | Cost |
-|----------|-------------|------|
-| **Claude** (Anthropic) | API Key | Paid |
-| **Claude** (Subscription) | OAuth (Pro/Max) | Subscription |
-| **OpenAI** (ChatGPT) | API Key | Paid |
-| **ChatGPT** (Subscription) | OAuth (Plus/Pro) | Subscription |
-| **GitHub Copilot** | OAuth | Free with subscription |
-| **Ollama** | None (local) | Free |
-| **OpenRouter** | API Key | Pay per use |
+| Provider | Type |
+|----------|------|
+| **Claude** (Anthropic) | API Key or Pro/Max subscription |
+| **OpenAI** (ChatGPT) | API Key or Plus/Pro subscription |
+| **GitHub Copilot** | Free with Copilot subscription |
+| **Ollama** | Free, runs locally |
+| **OpenRouter** | Pay-per-use, multiple models |
 
-Switch models anytime:
-
-```bash
-b --model
-```
+Switch anytime: `b --model`
 
 ---
 
-## Themes
-
-Customize the color theme:
-
-```bash
-b --theme
-```
+## All Commands
 
-Themes apply to both the CLI and interactive chat mode.
+### Core
+| Command | Description |
+|---------|-------------|
+| `b <query>` | Convert natural language to shell command |
+| `b --chat` | Start interactive AI chat session |
 
----
+### Configuration
+| Command | Description |
+|---------|-------------|
+| `b --auth` | Configure AI provider |
+| `b --config` | View current configuration |
+| `b --model` | Change AI provider/model |
+| `b --theme` | Change color theme |
 
-## History & Stats
+### Shortcuts
+| Command | Description |
+|---------|-------------|
+| `b --shortcuts` | List all shortcuts |
+| `b --add-shortcut` | Add a new shortcut |
+| `b --remove-shortcut <name>` | Remove a shortcut |
+| `b --edit-shortcuts` | Edit shortcuts in editor |
 
-Bashio tracks your command history locally.
+### History & Stats
+| Command | Description |
+|---------|-------------|
+| `b --history` | View command history |
+| `b --history --search <term>` | Search history |
+| `b --stats` | View usage statistics |
+| `b --suggest-shortcuts` | Suggest shortcuts from history |
+| `b --clear-history` | Clear command history |
 
-```bash
-b --history              # View recent commands
-b --history --search git # Search history
-b --stats                # Usage statistics
-b --suggest-shortcuts    # Get shortcut suggestions based on usage
-b --clear-history        # Clear history
-```
+### Help
+| Command | Description |
+|---------|-------------|
+| `b --help` | Show help message |
+| `b --version` | Show version (with update check) |
 
 ---
 
 ## Safety
 
-Bashio detects dangerous commands (like `rm -rf`) and shows extra warnings:
+Bashio warns you about dangerous commands:
 
 ```
   > rm -rf ~/*
 
   WARNING: This command may cause irreversible changes.
-  Reasons:
   - Uses recursive force delete (rm -rf)
   - Targets home directory
 
@@ -233,58 +169,26 @@ Every command requires confirmation before execution.
 
 ---
 
-## All Commands
+## Privacy
 
-| Command | Description |
-|---------|-------------|
-| `b <query>` | Convert natural language to command |
-| `b <shortcut> [args]` | Run a saved shortcut |
-| `b --chat` | Start interactive chat mode |
-| `b --auth` | Setup AI provider |
-| `b --model` | Change AI model |
-| `b --config` | View current config |
-| `b --theme` | Change color theme |
-| `b --shortcuts` | List shortcuts |
-| `b --add-shortcut` | Create shortcut |
-| `b --remove-shortcut <name>` | Delete shortcut |
-| `b --edit-shortcuts` | Edit shortcuts file |
-| `b --history` | View command history |
-| `b --stats` | Usage statistics |
-| `b --suggest-shortcuts` | Get shortcut suggestions |
-| `b --clear-history` | Clear history |
-| `b --help` | Show help |
-| `b --version` | Show version (with update check) |
+- All data stored locally at `~/.bashio/`
+- No telemetry or tracking
+- Queries only sent to your chosen AI provider
 
 ---
 
-## Configuration
-
-All data is stored locally at `~/.bashio/`:
-
-```
-~/.bashio/
-├── config.json      # Settings and API keys
-├── shortcuts.json   # Your shortcuts
-├── sessions/        # Chat sessions
-└── history.db       # Command history
-```
-
-View your config:
+## License
 
-```bash
-b --config
-```
+Copyright 2025 [Vranda Garg](https://vrandagarg.in)
 
----
+**If you use, modify, or distribute this project, you must:**
+1. Give credit to **Vranda Garg** as the original author
+2. Link to [github.com/VrandaaGarg/bashio](https://github.com/VrandaaGarg/bashio)
 
-## Privacy
-
-- All data stays on your machine
-- No telemetry or tracking
-- Queries only sent to your chosen AI provider
+Licensed under Apache 2.0 · [View LICENSE](https://github.com/VrandaaGarg/bashio/blob/main/LICENSE)
 
 ---
 
-## License
-
-MIT
+<p align="center">
+  <a href="https://github.com/VrandaaGarg/bashio">GitHub</a> · <a href="https://www.npmjs.com/package/bashio">npm</a> · <a href="https://vrandagarg.in">Author</a>
+</p>