symlx 0.1.5 → 0.1.8
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 +29 -27
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,3 +1,32 @@
|
|
|
1
|
+
# Quick Start
|
|
2
|
+
|
|
3
|
+
In a CLI project with:
|
|
4
|
+
|
|
5
|
+
```json
|
|
6
|
+
{
|
|
7
|
+
"name": "awesome-cli",
|
|
8
|
+
"bin": {
|
|
9
|
+
"awesome-cli": "./dist/cli.js"
|
|
10
|
+
}
|
|
11
|
+
}
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
run:
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
symlx link
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
Then use your CLI normally:
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
awesome-cli --help
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
Use `symlx serve` when you want temporary session-scoped links with auto-cleanup on exit.
|
|
27
|
+
|
|
28
|
+
---
|
|
29
|
+
|
|
1
30
|
# symlx
|
|
2
31
|
|
|
3
32
|
Temporary command linker for local CLI development.
|
|
@@ -27,33 +56,6 @@ npx symlx serve
|
|
|
27
56
|
npm i -g symlx
|
|
28
57
|
```
|
|
29
58
|
|
|
30
|
-
## Quick Start
|
|
31
|
-
|
|
32
|
-
In a CLI project with:
|
|
33
|
-
|
|
34
|
-
```json
|
|
35
|
-
{
|
|
36
|
-
"name": "my-cli",
|
|
37
|
-
"bin": {
|
|
38
|
-
"my-cli": "./dist/cli.js"
|
|
39
|
-
}
|
|
40
|
-
}
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
run:
|
|
44
|
-
|
|
45
|
-
```bash
|
|
46
|
-
symlx link
|
|
47
|
-
```
|
|
48
|
-
|
|
49
|
-
Then use your CLI normally:
|
|
50
|
-
|
|
51
|
-
```bash
|
|
52
|
-
my-cli --help
|
|
53
|
-
```
|
|
54
|
-
|
|
55
|
-
Use `symlx serve` when you want temporary session-scoped links with auto-cleanup on exit.
|
|
56
|
-
|
|
57
59
|
## Alias
|
|
58
60
|
|
|
59
61
|
`symlx` can be clackful for power users, hence its alias: `cx`.
|