scorpion-cli 0.1.2 → 0.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/README.md +18 -6
  2. package/docs/installation.md +63 -0
  3. package/docs/model-selection.md +43 -0
  4. package/package.json +29 -13
  5. package/src/index.js +1 -1
package/README.md CHANGED
@@ -22,7 +22,14 @@ Powered by [Ollama](https://ollama.com) and **qwen3.5:0.8b**, Scorpion doesn't j
22
22
  - **🎨 Beautiful UI**: Rich ASCII tables, interactive spinners, live progress updates, and structured markdown rendering.
23
23
  - **🔧 System Control**: Execute commands, manage files, check system performance (CPU/RAM), and write code directly to files.
24
24
 
25
- ## What It Can Do
25
+ [![npm version](https://img.shields.io/npm/v/scorpion-cli?logo=npm)](https://www.npmjs.com/package/scorpion-cli)
26
+ [![GitHub release](https://img.shields.io/github/v/release/amaansyed27/scorpion-cli-agent)](https://github.com/amaansyed27/scorpion-cli-agent/releases)
27
+
28
+ Scorpion is a local AI agent CLI for Windows, macOS, and Linux. Powered by [Ollama](https://ollama.com), it provides interactive local model selection, web research, file and system tools, and persistent session settings without requiring a paid AI API.
29
+
30
+ Use Scorpion from any terminal to chat with locally available Ollama models, run deep research, inspect your system, and work with files.
31
+
32
+ ## What It Can Do
26
33
 
27
34
  - **"Research the latest developments in quantum computing"** (Triggers Deep Research)
28
35
  - **"What's the current stock price of NVIDIA?"** (Triggers Web Search)
@@ -55,34 +62,39 @@ Powered by [Ollama](https://ollama.com) and **qwen3.5:0.8b**, Scorpion doesn't j
55
62
 
56
63
  ### Install from npm
57
64
 
58
- After the `0.1.0` release, Scorpion can be installed on Windows, macOS, and Linux:
65
+ Scorpion can be installed on Windows, macOS, and Linux:
59
66
 
60
67
  ```bash
61
68
  # Global npm install
62
- npm install --global scorpion-cli@0.1.2
69
+ npm install --global scorpion-cli@0.1.3
63
70
  scorpion
64
71
 
65
72
  # Run without installing globally
66
- npx scorpion-cli@0.1.2
73
+ npx scorpion-cli@0.1.3
67
74
  ```
68
75
 
69
76
  PowerShell:
70
77
 
71
78
  ```powershell
72
- irm https://raw.githubusercontent.com/amaansyed27/scorpion-cli-agent/v0.1.2/install.ps1 | iex
79
+ irm https://raw.githubusercontent.com/amaansyed27/scorpion-cli-agent/v0.1.3/install.ps1 | iex
73
80
  scorpion
74
81
  ```
75
82
 
76
83
  macOS/Linux:
77
84
 
78
85
  ```bash
79
- curl -fsSL https://raw.githubusercontent.com/amaansyed27/scorpion-cli-agent/v0.1.2/install.sh | sh
86
+ curl -fsSL https://raw.githubusercontent.com/amaansyed27/scorpion-cli-agent/v0.1.3/install.sh | sh
80
87
  scorpion
81
88
  ```
82
89
 
83
90
  The current `https://aish.dawnlightlabs.com/install.ps1` endpoint belongs to AiSH and should not be used for Scorpion. Configure a separate Scorpion subdomain, such as `https://scorpion.dawnlightlabs.com/install.ps1`, to serve these installer files if you want a branded short URL.
84
91
 
85
92
  Scorpion is distributed as one Node.js package rather than separate native binaries, so the same release works across all three platforms. Ollama must still be installed and running locally.
93
+
94
+ ## Documentation
95
+
96
+ - [Installation and updates](docs/installation.md)
97
+ - [Model selection and persistent settings](docs/model-selection.md)
86
98
 
87
99
  ## 🎯 Usage & Power Commands
88
100
 
package/docs/installation.md ADDED
@@ -0,0 +1,63 @@
1
+ # Installation and updates
2
+
3
+ Scorpion is a Node.js CLI that uses a local Ollama installation. It supports Windows, macOS, and Linux.
4
+
5
+ ## Requirements
6
+
7
+ - Node.js 22.12 or newer
8
+ - [Ollama](https://ollama.com/download)
9
+ - At least one downloaded Ollama model
10
+
11
+ For example:
12
+
13
+ ```bash
14
+ ollama pull qwen3.5:0.8b
15
+ ```
16
+
17
+ ## npm
18
+
19
+ Install Scorpion globally:
20
+
21
+ ```bash
22
+ npm install --global scorpion-cli
23
+ scorpion
24
+ ```
25
+
26
+ Update an existing installation:
27
+
28
+ ```bash
29
+ npm update --global scorpion-cli
30
+ ```
31
+
32
+ ## npx
33
+
34
+ Run the current package without a global installation:
35
+
36
+ ```bash
37
+ npx scorpion-cli
38
+ ```
39
+
40
+ ## One-line installers
41
+
42
+ PowerShell:
43
+
44
+ ```powershell
45
+ irm https://raw.githubusercontent.com/amaansyed27/scorpion-cli-agent/v0.1.3/install.ps1 | iex
46
+ ```
47
+
48
+ macOS/Linux:
49
+
50
+ ```bash
51
+ curl -fsSL https://raw.githubusercontent.com/amaansyed27/scorpion-cli-agent/v0.1.3/install.sh | sh
52
+ ```
53
+
54
+ ## Run from source
55
+
56
+ ```bash
57
+ git clone https://github.com/amaansyed27/scorpion-cli-agent.git
58
+ cd scorpion-cli-agent
59
+ npm install
60
+ npm start
61
+ ```
62
+
63
+ Use `scorpion --help` to see command-line options and `/help` inside the interactive CLI for session commands.
package/docs/model-selection.md ADDED
@@ -0,0 +1,43 @@
1
+ # Model selection and persistent settings
2
+
3
+ Scorpion reads the models installed in your local Ollama instance. Start the CLI, then use:
4
+
5
+ ```text
6
+ /list
7
+ ```
8
+
9
+ to see installed models and:
10
+
11
+ ```text
12
+ /model
13
+ ```
14
+
15
+ to select one interactively. You can also switch directly:
16
+
17
+ ```text
18
+ /model qwen3.5:4b
19
+ ```
20
+
21
+ The selected model is saved locally and automatically reused on the next launch.
22
+
23
+ ## Settings file
24
+
25
+ By default Scorpion stores settings in:
26
+
27
+ ```text
28
+ ~/.scorpion/config.json
29
+ ```
30
+
31
+ Use `/settings` to display the active model, Ollama host, and exact settings-file location.
32
+
33
+ For isolated testing or automation, set `SCORPION_CONFIG_DIR` to another directory before starting Scorpion.
34
+
35
+ ## One-time override
36
+
37
+ Use a command-line override without changing the saved selection:
38
+
39
+ ```bash
40
+ scorpion --model qwen3.5:0.8b
41
+ ```
42
+
43
+ If the chosen model has been removed from Ollama, run `/list` and select an installed replacement.
package/package.json CHANGED
@@ -1,16 +1,18 @@
1
1
  {
2
2
  "name": "scorpion-cli",
3
- "version": "0.1.2",
4
- "description": "Agentic AI CLI assistant powered by Ollama",
3
+ "version": "0.1.3",
4
+ "description": "Local AI agent CLI powered by Ollama with interactive model selection, web research, and system tools.",
5
5
  "type": "module",
6
6
  "main": "src/index.js",
7
7
  "bin": {
8
8
  "scorpion": "src/index.js",
9
9
  "scorpion-cli": "src/index.js"
10
10
  },
11
- "files": [
12
- "src",
13
- "README.md",
11
+ "files": [
12
+ "src",
13
+ "docs/installation.md",
14
+ "docs/model-selection.md",
15
+ "README.md",
14
16
  "install.ps1",
15
17
  "install.sh"
16
18
  ],
@@ -19,14 +21,28 @@
19
21
  "dev": "node --watch src/index.js"
20
22
  },
21
23
  "keywords": [
22
- "ai",
23
- "cli",
24
- "ollama",
25
- "agent",
26
- "assistant"
27
- ],
28
- "author": "Amaan",
29
- "license": "MIT",
24
+ "ai",
25
+ "ai-agent",
26
+ "cli",
27
+ "command-line",
28
+ "deep-research",
29
+ "llm",
30
+ "local-ai",
31
+ "model-selection",
32
+ "nodejs",
33
+ "ollama",
34
+ "terminal"
35
+ ],
36
+ "author": "Amaan",
37
+ "license": "MIT",
38
+ "homepage": "https://github.com/amaansyed27/scorpion-cli-agent#readme",
39
+ "repository": {
40
+ "type": "git",
41
+ "url": "git+https://github.com/amaansyed27/scorpion-cli-agent.git"
42
+ },
43
+ "bugs": {
44
+ "url": "https://github.com/amaansyed27/scorpion-cli-agent/issues"
45
+ },
30
46
  "engines": {
31
47
  "node": ">=22.12.0"
32
48
  },
package/src/index.js CHANGED
@@ -19,7 +19,7 @@ import {
19
19
  } from './ui/formatter.js';
20
20
 
21
21
  // Package info
22
- const VERSION = '0.1.2';
22
+ const VERSION = '0.1.3';
23
23
  const NAME = 'scorpion';
24
24
 
25
25
  // Setup CLI