Skip to content

Commit ba8b511

Browse files
axpnetEhudKirshclaude
committed
docs(cli): scope aftp and alias-toggle to their supported platforms
aftp ships automatically only on the Linux packages; on Windows/macOS use the manual alias. alias-toggle runs on Linux and macOS only; note that Windows is not yet supported and point to the PowerShell recipe. Native Windows support is in progress. Corrects an overclaim reported in #273. Co-Authored-By: EhudKirsh <EhudKirsh@users.noreply.github.com> Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent e3ec629 commit ba8b511

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

cli/installation.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,9 +45,9 @@ sudo ln -s "$(pwd)/squashfs-root/usr/bin/aeroftp-cli" /usr/local/bin/aeroftp
4545

4646
Typing `aeroftp-cli` in full gets tedious for interactive use. Two shorter names are available, and both run exactly the same binary.
4747

48-
### `aftp` (built-in)
48+
### `aftp` (built-in on Linux)
4949

50-
`aftp` is a built-in four-character name for the CLI. It is always present, with no setup required. Anything that works under `aeroftp-cli` works under `aftp`:
50+
`aftp` is a four-character name for the CLI. On the Linux packages (`.deb`, `.rpm`, `.snap`) it is installed automatically alongside `aeroftp`, with no setup required. On Windows and macOS, where the binary is not auto-added to `PATH`, set it up with the manual alias shown below for now (native `aftp` in the Windows installer is on the way). Anything that works under `aeroftp-cli` works under `aftp`:
5151

5252
```bash
5353
aftp ls sftp://user@host/
@@ -58,6 +58,8 @@ aftp sync ./local sftp://user@host/backup
5858

5959
`aero` is provided as an opt-in alias you enable with a single command. It is deliberately not shipped as a global binary, because a package owning `/usr/bin/aero` would fail to install on any system where another package already owns that path (a file conflict at the package-manager level).
6060

61+
> The `alias-toggle` command currently runs on Linux and macOS. On Windows it is not available yet (native support is on the way): use the manual PowerShell recipe in the table below in the meantime.
62+
6163
The same command both enables and disables the alias (toggle):
6264

6365
```bash

0 commit comments

Comments
 (0)