@devkitvault/recall 1.0.3 → 1.0.5
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 +54 -14
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,10 +1,12 @@
|
|
|
1
1
|
# @devkitvault/recall
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
**recall** is a cloud-synced CLI command vault — save terminal commands once, search and run them from any machine.
|
|
4
|
+
|
|
5
|
+
Works with [recall.devkitvault.com](https://recall.devkitvault.com) and the [VS Code extension](https://marketplace.visualstudio.com/items?itemName=devkitvault.recall-cmd).
|
|
4
6
|
|
|
5
7
|
## Requirements
|
|
6
8
|
|
|
7
|
-
-
|
|
9
|
+
- [Node.js](https://nodejs.org/) **18 or newer**
|
|
8
10
|
|
|
9
11
|
## Install
|
|
10
12
|
|
|
@@ -12,30 +14,68 @@ Global **recall** CLI for **Node.js 18+**. Same vault as [recall.devkitvault.com
|
|
|
12
14
|
npm install -g @devkitvault/recall
|
|
13
15
|
```
|
|
14
16
|
|
|
15
|
-
|
|
17
|
+
Verify the install:
|
|
18
|
+
|
|
19
|
+
```sh
|
|
20
|
+
recall --version
|
|
21
|
+
recall doctor
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## Quick start
|
|
16
25
|
|
|
17
26
|
```sh
|
|
18
|
-
recall --help
|
|
19
27
|
recall auth login
|
|
20
|
-
recall save "docker compose up -d"
|
|
28
|
+
recall save "docker compose up -d" --name start-stack --tags docker
|
|
21
29
|
recall search docker
|
|
30
|
+
recall list
|
|
31
|
+
recall run start-stack
|
|
22
32
|
```
|
|
23
33
|
|
|
24
|
-
|
|
34
|
+
Run `recall --help` for the full command list.
|
|
35
|
+
|
|
36
|
+
## Authentication
|
|
37
|
+
|
|
38
|
+
After `recall auth login`, your session is stored locally so you stay signed in between runs.
|
|
39
|
+
|
|
40
|
+
```sh
|
|
41
|
+
recall auth login # sign in (browser or email/password)
|
|
42
|
+
recall auth logout # sign out on this machine
|
|
43
|
+
recall auth whoami # show the signed-in account
|
|
44
|
+
```
|
|
25
45
|
|
|
26
|
-
|
|
46
|
+
## Prefer a standalone binary?
|
|
27
47
|
|
|
28
|
-
|
|
48
|
+
If you do not want Node.js, use the native installer instead — same commands, no runtime required:
|
|
29
49
|
|
|
30
|
-
|
|
50
|
+
- **macOS / Linux:** `curl -fsSL https://devkitvault.com/recall/install.sh | sh`
|
|
51
|
+
- **Windows:** `irm https://devkitvault.com/recall/install.ps1 | iex`
|
|
31
52
|
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
53
|
+
See [devkitvault.com/recall](https://devkitvault.com/recall) for downloads and docs.
|
|
54
|
+
|
|
55
|
+
## Update
|
|
56
|
+
|
|
57
|
+
```sh
|
|
58
|
+
npm update -g @devkitvault/recall
|
|
35
59
|
```
|
|
36
60
|
|
|
37
|
-
|
|
61
|
+
## Troubleshooting
|
|
62
|
+
|
|
63
|
+
```sh
|
|
64
|
+
recall doctor # check install, auth, and API connectivity
|
|
65
|
+
recall auth whoami # confirm you are signed in
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
If something still fails, open an issue on [GitHub](https://github.com/devkitvault/recall/issues) or visit [recall.devkitvault.com](https://recall.devkitvault.com).
|
|
69
|
+
|
|
70
|
+
## Links
|
|
71
|
+
|
|
72
|
+
| | |
|
|
73
|
+
| --------- | ----------------------------------------------------------------------------------------- |
|
|
74
|
+
| Website | [devkitvault.com/recall](https://devkitvault.com) |
|
|
75
|
+
| Dashboard | [recall.devkitvault.com](https://recall.devkitvault.com) |
|
|
76
|
+
| VS Code | [Marketplace](https://marketplace.visualstudio.com/items?itemName=devkitvault.recall-cmd) |
|
|
77
|
+
| Issues | [github.com/devkitvault/recall](https://github.com/devkitvault/recall/issues) |
|
|
38
78
|
|
|
39
79
|
## License
|
|
40
80
|
|
|
41
|
-
MIT © [devkitvault](https://devkitvault.com)
|
|
81
|
+
MIT — see [LICENSE](./LICENSE). © [devkitvault](https://devkitvault.com)
|