Skip to content

Commit d1d0753

Browse files
committed
Document npm package usage
1 parent 370721a commit d1d0753

1 file changed

Lines changed: 21 additions & 3 deletions

File tree

README.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,24 @@ This package supports Termix login/logout, SSH-capable host listing, and a local
1010
- Windows is experimental for v1.
1111
- Node.js 24 or newer is required.
1212

13+
## Quick Start
14+
15+
Run without installing:
16+
17+
```sh
18+
npx @txchen/tersh --help
19+
npx @txchen/tersh login --server https://termix.example
20+
npx @txchen/tersh hosts
21+
npx @txchen/tersh connect <host-id-or-name>
22+
```
23+
24+
Or install globally to use the `tersh` command directly:
25+
26+
```sh
27+
npm install -g @txchen/tersh
28+
tersh --help
29+
```
30+
1331
## Local Development
1432

1533
Run the focused command-boundary test suite:
@@ -24,7 +42,7 @@ Run syntax checks:
2442
npm run check
2543
```
2644

27-
## Local Execution
45+
## Local Execution From Source
2846

2947
Run the binary through Node:
3048

@@ -38,7 +56,7 @@ Run it directly from the working tree:
3856
./bin/tersh.js --help
3957
```
4058

41-
## Local Linking
59+
## Local Linking From Source
4260

4361
Link the package into your active npm prefix:
4462

@@ -55,7 +73,7 @@ npm unlink -g tersh
5573

5674
## Commands
5775

58-
The planned top-level commands are:
76+
The top-level commands are:
5977

6078
- `tersh login --server <url>`
6179
- `tersh hosts`

0 commit comments

Comments
 (0)