shortcutxl 0.2.0 → 0.2.1
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.
- package/README.md +10 -43
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,59 +1,26 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ShortcutXL
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
An AI agent that lives on your computer and has Excel superpowers through [Shortcut](https://shortcut.ai).
|
|
4
4
|
|
|
5
5
|
```bash
|
|
6
6
|
npm install -g shortcutxl
|
|
7
7
|
shortcut
|
|
8
8
|
```
|
|
9
9
|
|
|
10
|
-
> **Important:**
|
|
10
|
+
> **Important:** Install globally with `-g`. Do not use `npm install shortcutxl` without it.
|
|
11
11
|
|
|
12
12
|
## Capabilities
|
|
13
13
|
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
- **Data lives locally** - Your workbooks, files, and skills stay on your machine and are never sent to our servers.
|
|
14
|
+
- **Data lives locally** — Workbooks, files, and skills stay on your machine.
|
|
17
15
|
- **Multi-workbook operations** — Read and write across multiple open workbooks simultaneously.
|
|
18
|
-
- **Deep feature control** —
|
|
16
|
+
- **Deep feature control** — Pivots, charts, sensitivity tables, iterative recalculations, and more.
|
|
19
17
|
- **VBA access** — Read, write, and run macros. Create VBA modules programmatically.
|
|
20
18
|
- **File system access** — Save to arbitrary paths, open files from disk, export PDFs.
|
|
21
|
-
- **Extensible** — Integrate any API or data source
|
|
22
|
-
- **User-defined functions (UDFs)** —
|
|
19
|
+
- **Extensible** — Integrate any API or data source by adding a skill file or a custom tool extension.
|
|
20
|
+
- **User-defined functions (UDFs)** — Custom Excel formulas powered by Python for live data, calculations, or database queries.
|
|
23
21
|
- **External data connections** — ODBC, OLE DB, QueryTables, Power Query.
|
|
24
22
|
|
|
25
|
-
##
|
|
26
|
-
|
|
27
|
-
### Prerequisites
|
|
28
|
-
|
|
29
|
-
- **Windows 10 or 11** with **Microsoft Excel 2016 or later** (64-bit)
|
|
30
|
-
- **Node.js >= 20** — This gives you `npm`, the package manager used to install the agent.
|
|
31
|
-
|
|
32
|
-
If you don't have Node.js installed, open a terminal (Command Prompt, PowerShell, or Windows Terminal) and run:
|
|
33
|
-
|
|
34
|
-
```
|
|
35
|
-
winget install OpenJS.NodeJS.LTS
|
|
36
|
-
```
|
|
37
|
-
|
|
38
|
-
This will prompt you to approve a Windows admin dialog (UAC) — click **Yes**. After it finishes, **close and reopen your terminal** so the `npm` command is available.
|
|
39
|
-
|
|
40
|
-
> **No winget?** Download the installer directly from [nodejs.org](https://nodejs.org) and run it — accept the defaults.
|
|
41
|
-
|
|
42
|
-
### Install
|
|
43
|
-
|
|
44
|
-
```bash
|
|
45
|
-
npm install -g shortcutxl
|
|
46
|
-
shortcut
|
|
47
|
-
```
|
|
48
|
-
|
|
49
|
-
On first launch the agent guides you through setup step by step:
|
|
50
|
-
|
|
51
|
-
1. **Git Bash** — Required for the agent's shell. If missing, the agent installs it for you via `winget` (admin approval needed).
|
|
52
|
-
2. **Python 3.12** — The agent checks for Python 3.12 and installs it if needed (with your permission, per-user, no admin required).
|
|
53
|
-
3. **Excel add-in** — Registered with Excel so it loads automatically on startup. The agent opens Excel for you after this step.
|
|
54
|
-
|
|
55
|
-
After setup, just run `shortcut` — Excel opens automatically with the agent connected.
|
|
56
|
-
|
|
57
|
-
## Links
|
|
23
|
+
## Prerequisites
|
|
58
24
|
|
|
59
|
-
-
|
|
25
|
+
- **Windows 10/11** with **Excel 2016+** (64-bit)
|
|
26
|
+
- **Node.js >= 20** — If missing: `winget install OpenJS.NodeJS.LTS`
|