@aishelf/service 1.0.0 → 1.0.1

package/README.md

@@ -1,279 +1,60 @@
 # @aishelf/service
 
-AIShelf local service for cross-platform file access. Provides a simple HTTP API to manage files in `~/.aishelf/`.
+A lightweight background service that powers AIShelf clients - including the VS Code extension and other future clients. It acts as a centralized source of workflows, skills, prompts, and rules for all your AI tools across your local machine, handling authentication and registry management so that AIShelf tools can securely access your shared AI resources.
 
-## Installation
-
-```bash
-npm install -g @aishelf/service
-```
-
-## Usage
-
-### Get help
-
-```bash
-aishelf-service --help
-aishelf-service help [command]
-```
-
-### Check version
-
-```bash
-aishelf-service --version
-```
-
-### Start the service
-
-```bash
-aishelf-service start
-```
-
-### Stop the service
-
-```bash
-aishelf-service stop
-```
-
-### Restart the service
-
-```bash
-aishelf-service restart
-```
-
-### Check status
-
-```bash
-aishelf-service status
-```
-
-## API
-
-The service runs on `http://localhost:5314` and provides a simple file API:
-
-### GET - Read file or list directory
-
-```bash
-# List directory
-curl http://localhost:5314/storage/registries
-
-# Read file
-curl http://localhost:5314/storage/registries/user-repo/workflow.md
-```
-
-**Response for directory:**
-```json
-{
-  "path": "/storage/registries",
-  "type": "directory",
-  "contents": [
-    {
-      "name": "user-repo",
-      "type": "directory",
-      "path": "/storage/registries/user-repo"
-    }
-  ]
-}
-```
-
-**Response for file:**
-```
-# Workflow content here...
-```
-
-### POST - Create file
-
-```bash
-curl -X POST http://localhost:5314/storage/registries/user-repo/test.md \
-  -H "Content-Type: application/json" \
-  -d '{"content": "# Test"}'
-```
-
-**Response:**
-```json
-{
-  "success": true,
-  "path": "/storage/registries/user-repo/test.md"
-}
-```
-
-### PUT - Update file
+For full installation instructions and documentation, visit [aishelf.dev/docs/installation](https://aishelf.dev/docs/installation).
 
-```bash
-curl -X PUT http://localhost:5314/storage/registries/user-repo/test.md \
-  -H "Content-Type: application/json" \
-  -d '{"content": "# Updated"}'
-```
+## Installation
 
-**Response:**
-```json
-{
-  "success": true,
-  "path": "/storage/registries/user-repo/test.md"
-}
-```
+### Docker (Recommended)
 
-### DELETE - Delete file or directory
+Docker is the recommended way to run the AIShelf service. It handles auto-updates and restarts automatically when Docker starts.
 
 ```bash
-curl -X DELETE http://localhost:5314/storage/registries/user-repo/test.md
+docker run -d \
+  --name aishelf-service \
+  --restart=unless-stopped \
+  -p 5314:5314 \
+  -v ~/.aishelf:/root/.aishelf \
+  aishelf/service:latest
 ```
 
-**Response:**
-```json
-{
-  "success": true,
-  "path": "/storage/registries/user-repo/test.md"
-}
-```
-
-## Auto-Start on Login (Optional)
-
-If you want the service to start automatically when you log in, follow the instructions for your platform:
+See [aishelf.dev/docs/installation#docker](https://aishelf.dev/docs/installation#docker) for more details.
 
-### macOS
+### npm global install (Beta)
 
-Create `~/Library/LaunchAgents/com.aishelf.service.plist`:
-
-```xml
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
-<plist version="1.0">
-<dict>
-    <key>Label</key>
-    <string>com.aishelf.service</string>
-    <key>ProgramArguments</key>
-    <array>
-        <string>/usr/local/bin/node</string>
-        <string>/usr/local/lib/node_modules/@aishelf/service/dist/cli.js</string>
-        <string>start</string>
-    </array>
-    <key>RunAtLoad</key>
-    <true/>
-    <key>KeepAlive</key>
-    <true/>
-    <key>StandardOutPath</key>
-    <string>/Users/YOUR_USERNAME/.aishelf/logs/service.log</string>
-    <key>StandardErrorPath</key>
-    <string>/Users/YOUR_USERNAME/.aishelf/logs/service.error.log</string>
-</dict>
-</plist>
-```
-
-Replace `YOUR_USERNAME` with your actual username, then load the service:
-
-```bash
-launchctl load ~/Library/LaunchAgents/com.aishelf.service.plist
-```
+> **Note:** This installation method is currently in beta. Docker is recommended if available.
 
-To unload:
 ```bash
-launchctl unload ~/Library/LaunchAgents/com.aishelf.service.plist
-```
-
-### Linux
-
-Create `~/.config/systemd/user/aishelf-service.service`:
-
-```ini
-[Unit]
-Description=AIShelf Local Service
-After=network.target
-
-[Service]
-Type=simple
-ExecStart=/usr/bin/node /usr/local/lib/node_modules/@aishelf/service/dist/cli.js start
-Restart=always
-RestartSec=10
-StandardOutput=append:/home/YOUR_USERNAME/.aishelf/logs/service.log
-StandardError=append:/home/YOUR_USERNAME/.aishelf/logs/service.error.log
-
-[Install]
-WantedBy=default.target
+npm install -g @aishelf/service
+aishelf service install
 ```
 
-Replace `YOUR_USERNAME` with your actual username, then enable and start:
-
-```bash
-systemctl --user daemon-reload
-systemctl --user enable aishelf-service
-systemctl --user start aishelf-service
-```
+See [aishelf.dev/docs/installation#npm](https://aishelf.dev/docs/installation#npm) for more details.
 
-To check status:
-```bash
-systemctl --user status aishelf-service
-```
+## Usage
 
-To stop:
 ```bash
-systemctl --user stop aishelf-service
-```
-
-### Windows
-
-Using NSSM (Non-Sucking Service Manager):
-
-1. Install NSSM:
-```powershell
-choco install nssm
-```
-
-2. Install the service:
-```powershell
-nssm install AIShelfService "C:\Program Files\nodejs\node.exe" "C:\Users\YOUR_USERNAME\AppData\Roaming\npm\node_modules\@aishelf\service\dist\cli.js" start
-nssm set AIShelfService Start SERVICE_AUTO_START
-nssm start AIShelfService
+aishelf service start    # start the service
+aishelf service stop     # stop the service
+aishelf service restart  # restart the service
+aishelf --version        # check version
+aishelf --help           # get help
 ```
 
-Replace `YOUR_USERNAME` with your actual username.
-
-To stop:
-```powershell
-nssm stop AIShelfService
-```
-
-To remove:
-```powershell
-nssm remove AIShelfService confirm
-```
-
-## Security
-
-- **Localhost only**: The service only accepts requests from `localhost` (not exposed to the internet)
-- **Path traversal protection**: Prevents `..` in paths to avoid accessing files outside `~/.aishelf/`
-- **CORS enabled**: Allows browser extensions to make requests
+## How it works
 
-## Environment Variables
+Once running, `@aishelf/service` exposes a local HTTP API on `localhost:5314`. AIShelf clients (IDE extensions, browser extensions, etc.) communicate with it to:
 
-- `AISHELF_PORT`: Change the port (default: 5314)
-  ```bash
-  AISHELF_PORT=8080 aishelf-service start
-  ```
+- Authenticate with your GitHub account
+- Connect and sync AIShelf registries
+- Read and manage your shared AI resources locally
 
-## Troubleshooting
+You typically don't need to interact with this service directly — it's managed automatically by the AIShelf clients you use.
 
-### Port already in use
-
-If port 5314 is already in use, you can change it:
-
-```bash
-AISHELF_PORT=8080 aishelf-service start
-```
-
-### Service won't start
-
-Check the logs:
-```bash
-cat ~/.aishelf/logs/service.log
-```
-
-### Permission denied
+## API
 
-Make sure the CLI is executable:
-```bash
-chmod +x /usr/local/lib/node_modules/@aishelf/service/dist/cli.js
-```
+API documentation coming soon. Visit [aishelf.dev](https://aishelf.dev) for updates.
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aishelf/service",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "AIShelf local service for cross-platform file access",
   "main": "dist/server.js",
   "bin": {