argonuts 0.1.0 → 0.1.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 CHANGED
@@ -8,23 +8,87 @@ npx argonuts@latest library add ~/Movies
8
8
  npx argonuts@latest scan
9
9
  ```
10
10
 
11
- Or install it once and type `argonuts`:
11
+ ## Install
12
+
13
+ `argonuts` runs on Node.js 20 or later, which brings the `npx` and `npm` commands with it. If
14
+ `npx --version` already prints a version, skip to step 3.
15
+
16
+ ### Windows (x64 and ARM)
17
+
18
+ 1. Install Node.js. In Command Prompt or PowerShell:
19
+
20
+ ```bat
21
+ winget install --exact --id OpenJS.NodeJS.LTS --source winget
22
+ ```
23
+
24
+ `--source winget` takes Node.js from winget's own catalog and skips the store source (`msstore`),
25
+ which fails on some networks. Or use the Windows installer from the Node.js website.
26
+
27
+ 2. Close the terminal and open a new one, so it finds the new commands. Check that it worked:
28
+
29
+ ```bat
30
+ node --version
31
+ npx --version
32
+ ```
33
+
34
+ 3. Try argonuts, in Command Prompt:
35
+
36
+ ```bat
37
+ npx argonuts@latest --version
38
+ npx argonuts@latest library add "%USERPROFILE%\Videos"
39
+ npx argonuts@latest scan
40
+ ```
41
+
42
+ In PowerShell, write the folder as `"$HOME\Videos"`. If PowerShell answers _running scripts is
43
+ disabled on this system_, type `npx.cmd` instead of `npx` (and `argonuts.cmd` instead of
44
+ `argonuts`), or use Command Prompt. There is no need to change the execution policy.
45
+
46
+ ### macOS (Apple Silicon and Intel)
47
+
48
+ 1. Install Node.js with Homebrew (`brew install node`), or use the macOS installer from the Node.js
49
+ website.
50
+ 2. Open a new Terminal window and check: `node --version` and `npx --version`.
51
+ 3. Try argonuts:
52
+
53
+ ```sh
54
+ npx argonuts@latest --version
55
+ npx argonuts@latest library add ~/Movies
56
+ npx argonuts@latest scan
57
+ ```
58
+
59
+ ### Keep it installed
60
+
61
+ `npx` downloads argonuts the first time and reuses it afterwards. To type just `argonuts`, install it
62
+ once:
12
63
 
13
64
  ```sh
14
65
  npm install --global argonuts
15
66
  argonuts scan
16
67
  ```
17
68
 
69
+ Update it later with the same command.
70
+
71
+ ### When something goes wrong
72
+
73
+ | What you see | What to do |
74
+ | -------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
75
+ | `'npx' is not recognized` or `command not found: npx` | Node.js isn't installed, or the terminal was opened before it was. Do step 1, then open a new terminal |
76
+ | winget: `Failed when searching source: msstore` | The store source isn't reachable from this network (often a certificate error). Add `--source winget`, as in step 1 |
77
+ | PowerShell: `running scripts is disabled on this system` | Use `npx.cmd` / `argonuts.cmd`, or Command Prompt |
78
+ | `argonuts has no build for … yet` | Your computer isn't supported yet: Linux comes next |
79
+ | `@argonuts/cli-… is not installed` | npm skipped the part made for your computer. Run the command again; if you set npm to leave out optional packages (`omit=optional`), remove that setting |
80
+ | Windows blocks `argonuts-cli` | Version 0.1's programs aren't signed yet. On Windows 11 with Smart App Control turned on, they can't run; signed builds are planned |
81
+
18
82
  ## Commands
19
83
 
20
- | Command | What it does |
21
- | --- | --- |
22
- | `argonuts library` | Your library's folders and their last scans |
23
- | `argonuts library add <folder>...` | Add folders to your library |
24
- | `argonuts library remove <folder>` | Remove a folder; its last scan stays on disk |
25
- | `argonuts scan [<folder>...]` | Scan every library folder, or the folders named, which join your library |
26
- | `argonuts scan --cached-only` | Use earlier thumbnails only and run no ffmpeg |
27
- | `argonuts --version` | The versions of argonuts and argonuts-cli |
84
+ | Command | What it does |
85
+ | ---------------------------------- | ------------------------------------------------------------------------ |
86
+ | `argonuts library` | Your library's folders and their last scans |
87
+ | `argonuts library add <folder>...` | Add folders to your library |
88
+ | `argonuts library remove <folder>` | Remove a folder; its last scan stays on disk |
89
+ | `argonuts scan [<folder>...]` | Scan every library folder, or the folders named, which join your library |
90
+ | `argonuts scan --cached-only` | Use earlier thumbnails only and run no ffmpeg |
91
+ | `argonuts --version` | The versions of argonuts and argonuts-cli |
28
92
 
29
93
  Ctrl-C stops a scan; a second Ctrl-C stops it at once. A scan reads your files and never changes
30
94
  them.
@@ -40,8 +104,11 @@ Set `ARGONUTS_DATA_DIR` to keep it somewhere else.
40
104
 
41
105
  ## Computers it runs on
42
106
 
43
- macOS on Apple Silicon and Intel, and Windows on x64, with Node.js 20 or later. Linux and Windows on
44
- ARM come next.
107
+ macOS on Apple Silicon and Intel, and Windows on x64 and on ARM, with Node.js 20 or later. Linux
108
+ comes next.
109
+
110
+ On Windows on ARM, argonuts uses the x64 build for now, which Windows 11 runs through its built-in
111
+ x64 emulation. A native ARM build will replace it.
45
112
 
46
113
  The work is done by `argonuts-cli`, the core's own program, which npm installs with argonuts for your
47
114
  computer only, together with the `ffmpeg` and `ffprobe` it uses for thumbnails.
package/bin/argonuts.js CHANGED
@@ -7,7 +7,8 @@ import path from "node:path";
7
7
  var PLATFORMS = {
8
8
  "darwin-arm64": "macOS on Apple Silicon",
9
9
  "darwin-x64": "macOS on Intel",
10
- "win32-x64": "Windows on x64"
10
+ "win32-x64": "Windows on x64",
11
+ "win32-arm64": "Windows on ARM"
11
12
  };
12
13
 
13
14
  class CompanionError extends Error {
@@ -298,7 +299,7 @@ function printSummary(snapshot) {
298
299
  }
299
300
 
300
301
  // src/main.ts
301
- var VERSION = "0.1.0";
302
+ var VERSION = "0.1.1";
302
303
  var HELP = `argonuts ${VERSION}: your media library, from the terminal.
303
304
 
304
305
  Usage:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "argonuts",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "Your media library from the terminal: add folders, scan them and keep their thumbnails ready.",
5
5
  "license": "MIT",
6
6
  "type": "module",
@@ -16,8 +16,9 @@
16
16
  "node": ">=20"
17
17
  },
18
18
  "optionalDependencies": {
19
- "@argonuts/cli-darwin-arm64": "0.1.0",
20
- "@argonuts/cli-darwin-x64": "0.1.0",
21
- "@argonuts/cli-win32-x64": "0.1.0"
19
+ "@argonuts/cli-darwin-arm64": "0.1.1",
20
+ "@argonuts/cli-darwin-x64": "0.1.1",
21
+ "@argonuts/cli-win32-x64": "0.1.1",
22
+ "@argonuts/cli-win32-arm64": "0.1.1"
22
23
  }
23
24
  }