Merge pull request #54 from dgwyer/add-uv-docs

Add uv installation docs

Author: ncoop57

README.md

@@ -35,7 +35,54 @@ Install ShellSage directly from PyPI using pip:
 pip install shell-sage
 ```
 
-### Prerequisites
+## Installing with `uv`
+
+If you have `uv` installed then you can use its powerful `tool` feature
+to install ShellSage as a global CLI — safely, with per-tool isolation
+and no need for manual virtualenv management.
+
+``` sh
+uv tool install shell_sage
+```
+
+This will make the `ssage` CLI available everywhere on your system.
+
+If you also want to install additional dependencies (for example
+`fastlite`), you can do it at install time:
+
+``` sh
+uv tool install --with fastlite shell_sage
+```
+
+### Upgrade
+
+To upgrade ShellSage to the latest version:
+
+``` sh
+uv tool upgrade shell_sage
+```
+
+### List All Installed Tools
+
+See everything you’ve installed via `uv tool`:
+
+``` sh
+uv tool list
+```
+
+### Uninstall
+
+To completely remove ShellSage and its environment:
+
+``` sh
+uv tool uninstall shell_sage
+```
+
+Using `uv tool` keeps ShellSage completely isolated from your project
+dependencies, so you can safely use `ssage` even when inside another
+virtual environment.
+
+## Prerequisites
 
 1.  **API Key Setup**
 

nbs/index.ipynb

@@ -45,7 +45,7 @@
   },
   {
    "cell_type": "markdown",
-   "id": "082bf63c",
+   "id": "915c854d",
    "metadata": {},
    "source": [
     "## Installation\n",
@@ -55,8 +55,49 @@
     "```sh\n",
     "pip install shell-sage\n",
     "```\n",
+    "## Installing with `uv`\n",
     "\n",
-    "### Prerequisites\n",
+    "If you have `uv` installed then you can use its powerful `tool` feature to install ShellSage as a global CLI — safely, with per-tool isolation and no need for manual virtualenv management.\n",
+    "\n",
+    "```sh\n",
+    "uv tool install shell_sage\n",
+    "```\n",
+    "\n",
+    "This will make the `ssage` CLI available everywhere on your system.\n",
+    "\n",
+    "If you also want to install additional dependencies (for example `fastlite`), you can do it at install time:\n",
+    "\n",
+    "```sh\n",
+    "uv tool install --with fastlite shell_sage\n",
+    "```\n",
+    "\n",
+    "### Upgrade\n",
+    "\n",
+    "To upgrade ShellSage to the latest version:\n",
+    "\n",
+    "```sh\n",
+    "uv tool upgrade shell_sage\n",
+    "```\n",
+    "\n",
+    "### List All Installed Tools\n",
+    "\n",
+    "See everything you’ve installed via `uv tool`:\n",
+    "\n",
+    "```sh\n",
+    "uv tool list\n",
+    "```\n",
+    "\n",
+    "### Uninstall\n",
+    "\n",
+    "To completely remove ShellSage and its environment:\n",
+    "\n",
+    "```sh\n",
+    "uv tool uninstall shell_sage\n",
+    "```\n",
+    "\n",
+    "Using `uv tool` keeps ShellSage completely isolated from your project dependencies, so you can safely use `ssage` even when inside another virtual environment.\n",
+    "\n",
+    "## Prerequisites\n",
     "\n",
     "1. **API Key Setup**\n",
     "   ```sh\n",