| … | … | @@ -0,0 +1,63 @@ |
| 1 | # hyperident-shell |
| 2 | |
| 3 | A P2P shell keyed by your [hyperident](../hyperident) device identity. **The shell address is |
| 4 | your device pubkey** — there is no host, no port and no account. |
| 5 | |
| 6 | Bare-native, and runs on Node too. |
| 7 | |
| 8 | ## Install |
| 9 | |
| 10 | ```sh |
| 11 | pgh app install hyperident-shell |
| 12 | ``` |
| 13 | |
| 14 | ## Usage |
| 15 | |
| 16 | ```sh |
| 17 | hyperident-shell id # your device pubkey — this is the address others dial |
| 18 | hyperident-shell serve # accept connections on it |
| 19 | hyperident-shell <pubkey> # connect |
| 20 | hyperident-shell <pubkey> -- ls -l # run one command and exit |
| 21 | ``` |
| 22 | |
| 23 | Names are local aliases, not a namespace: |
| 24 | |
| 25 | ```sh |
| 26 | hyperident-shell add-name celltron <pubkey> |
| 27 | hyperident-shell names |
| 28 | hyperident-shell celltron # resolves via the local names store, else treats it as a pubkey |
| 29 | ``` |
| 30 | |
| 31 | ## The firewall is deny-by-default |
| 32 | |
| 33 | ```sh |
| 34 | hyperident-shell serve --firewall ~/.hyperident-shell/allowed |
| 35 | hyperident-shell serve --disable-firewall |
| 36 | ``` |
| 37 | |
| 38 | The firewall file is one key per line (z-base32 or hex), `#` for comments. **A missing file |
| 39 | means an empty allow-list, which denies everyone** — a typo in the path fails closed rather |
| 40 | than open. `--disable-firewall` is the explicit way to accept anyone, and it has to be asked |
| 41 | for by name. |
| 42 | |
| 43 | ## Storage |
| 44 | |
| 45 | ``` |
| 46 | ~/.hyperident-shell/config.json |
| 47 | ~/.hyperident-shell/registry-store/ |
| 48 | ~/.hyperident-shell/registry-host-store/ |
| 49 | ``` |
| 50 | |
| 51 | ## Commands |
| 52 | |
| 53 | | | | |
| 54 | |---|---| |
| 55 | | `id` | print your device pubkey (the shell address) | |
| 56 | | `serve [--firewall <file>] [--disable-firewall]` | serve a shell keyed by this device | |
| 57 | | `<name\|pubkey> [-- cmd ...]` | connect; runs one command if given, else interactive | |
| 58 | | `add-name <name> <pubkey>` | map a name to a device pubkey | |
| 59 | | `names` | list known names | |
| 60 | |
| 61 | ## License |
| 62 | |
| 63 | Not yet declared. |