Skip to content

Commit 27069ba

Browse files
committed
docs(cli): simplify installation docs
1 parent deb7ed7 commit 27069ba

1 file changed

Lines changed: 14 additions & 48 deletions

File tree

README.md

Lines changed: 14 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -15,60 +15,31 @@
1515

1616
## Install
1717

18-
Choose the install path that fits your environment.
19-
20-
Install with the macOS/Linux helper script:
18+
Recommended on macOS and Linux:
2119

2220
```bash
2321
curl -fsSL https://raw.githubusercontent.com/putdotio/putio-cli/main/install.sh | sh
2422
```
2523

26-
The installer downloads the latest release binary, verifies the matching `.sha256` file, and installs `putio` into `~/.local/bin` by default.
24+
That installs the latest release to `~/.local/bin/putio`.
2725

28-
Useful overrides:
26+
Install somewhere else:
2927

3028
```bash
3129
curl -fsSL https://raw.githubusercontent.com/putdotio/putio-cli/main/install.sh | INSTALL_DIR=/usr/local/bin sh
32-
curl -fsSL https://raw.githubusercontent.com/putdotio/putio-cli/main/install.sh | PUTIO_CLI_VERSION=1.0.0 sh
3330
```
3431

35-
Install with npm if you already want the package through Node.js:
32+
If you want npm:
3633

3734
```bash
3835
npm install --global @putdotio/cli
3936
```
4037

41-
This path requires Node `24.14+`.
42-
43-
Install manually from GitHub Releases if you prefer to handle the archive yourself or you are on Windows:
44-
45-
1. Download the matching asset from [GitHub Releases](https://github.com/putdotio/putio-cli/releases/latest).
46-
2. Download the matching `.sha256` file for that asset.
47-
3. Verify the checksum.
48-
4. Extract the archive and place `putio` on your `PATH`.
49-
50-
Example asset names:
51-
52-
- `putio-cli-1.0.2-darwin-arm64.tar.gz`
53-
- `putio-cli-1.0.2-linux-amd64.tar.gz`
54-
- `putio-cli-1.0.2-windows-amd64.zip`
55-
56-
Verify a release binary on macOS or Linux:
38+
Requires Node `24.14+`.
5739

58-
```bash
59-
shasum -a 256 -c putio-cli-1.0.2-linux-amd64.tar.gz.sha256
60-
tar -xzf putio-cli-1.0.2-linux-amd64.tar.gz
61-
chmod +x putio
62-
mv putio /usr/local/bin/putio
63-
```
64-
65-
Verify a release binary on Windows PowerShell:
40+
Windows or manual install:
6641

67-
```powershell
68-
$expected = (Get-Content .\putio-cli-1.0.2-windows-amd64.zip.sha256).Split()[0]
69-
$actual = (Get-FileHash .\putio-cli-1.0.2-windows-amd64.zip -Algorithm SHA256).Hash.ToLower()
70-
if ($actual -ne $expected) { throw "Checksum mismatch" }
71-
```
42+
Download the matching archive from [GitHub Releases](https://github.com/putdotio/putio-cli/releases/latest), verify the `.sha256`, extract it, and put `putio` on your `PATH`.
7243

7344
Confirm the installed CLI:
7445

@@ -78,56 +49,51 @@ putio version
7849

7950
## Quick Start
8051

81-
Inspect the machine-readable command surface before guessing flags or payloads:
52+
Inspect the live contract:
8253

8354
```bash
8455
putio describe
8556
```
8657

87-
Start the device-link login flow:
58+
Link your account:
8859

8960
```bash
9061
putio auth login --open
9162
```
9263

93-
Then confirm the linked account:
64+
Check the account:
9465

9566
```bash
9667
putio whoami --output json
9768
```
9869

99-
List a small structured file result:
70+
Read a small JSON result:
10071

10172
```bash
10273
putio files list --per-page 5 --fields files,total --output json
10374
```
10475

105-
For larger reads, prefer streamed output:
76+
Stream larger reads:
10677

10778
```bash
10879
putio transfers list --page-all --output ndjson
10980
```
11081

111-
## Usage Notes
82+
## Tips
11283

11384
- Use `--output json` when you want a stable machine-readable contract for scripts, agents, and automation.
11485
- Use `--output ndjson` for large or continuous read workflows.
11586
- Use `--fields` to keep structured responses small.
11687
- Use `--dry-run` before mutating commands.
117-
- Set `PUTIO_CLI_TOKEN` when you want fully headless auth.
88+
- Set `PUTIO_CLI_TOKEN` for headless auth.
11889
- Use `PUTIO_CLI_CONFIG_PATH` to override the default config location.
119-
- `putio auth login` always prints the approval URL and code, so it still works in headless and remote environments.
12090

12191
## Docs
12292

12393
- [Architecture](./docs/ARCHITECTURE.md)
12494
- [Contributing](./CONTRIBUTING.md)
12595
- [Security](./SECURITY.md)
12696

127-
## Contributing
128-
129-
Contributor setup, development workflow, and validation live in [CONTRIBUTING.md](./CONTRIBUTING.md).
130-
13197
## License
13298

13399
This project is available under the MIT license. See [LICENSE](./LICENSE).

0 commit comments

Comments
 (0)