apollo/enbas
1
0
Fork 0
Code Issues 4 Pull requests Projects Activity Actions

update documentation

Browse source
This commit is contained in:
Dan Anglin 2024-07-31 01:19:57 +01:00
parent 3e47dea9ba
commit 96629c76f2
Signed by: dananglin
GPG key ID: 0C1D44CFBEE68638
1 changed files with 19 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
docs/manual.md
View file

@ -135,25 +135,13 @@ enbas whoami
## Accounts ## Accounts
### View your own account ### View account information
Prints the information from your own account.
- View information from your own account
``` ```
enbas show --type account --my-account enbas show --type account --my-account
``` ```
- View information from a local or remote account.
| flag | type | required | description | default |
|------|------|----------|-------------|---------|
| `type` | string | true | The resource you want to view. Here this should be `account`. | |
| `my-account` | boolean | true | Use this flag to view your own account. | |
| `show-preferences` | boolean | false | Show your posting preferences. | false |
### View an account
Prints the information of a local or a remote account.
If the account is unknown by your instance a `404` message will be shown instead.
``` ```
enbas show --type account --account-name @name@example.social enbas show --type account --account-name @name@example.social
``` ```
@ -161,9 +149,23 @@ enbas show --type account --account-name @name@example.social
| flag | type | required | description | default | | flag | type | required | description | default |
|------|------|----------|-------------|---------| |------|------|----------|-------------|---------|
| `type` | string | true | The resource you want to view. Here this should be `account`. | | | `type` | string | true | The resource you want to view. Here this should be `account`. | |
| `my-account` | boolean | true | Use this flag to view your own account. | |
| `show-preferences` | boolean | false | Show your posting preferences. | false |
| `account-name` | string | true | The name of the account to view. | | | `account-name` | string | true | The name of the account to view. | |
| `skip-relationship` | boolean | false | Set to `true` to skip viewing your relationship to the account you are viewing (including the private note if you've created one). | false | | `skip-relationship` | boolean | false | Set to `true` to skip viewing your relationship to the account you are viewing (including the private note if you've created one). | false |
Additional flags for viewing an account's statuses.
| flag | type | required | description | default |
|------|------|----------|-------------|---------|
| `show-statuses` | bool | Set to `true` to view the statuses created from this account. | false |
| `limit` | integer | The maximum amount of statuses to show from this account. | 20 |
| `exclude-replies` | bool | Set to `true` to exclude replies. | false |
| `exclude-boosts` | bool | Set to `true` to exclude boosts. | false |
| `only-pinned` | bool | Set to `true` to view only pinned statuses. | false |
| `only-media` | bool | Set to `true` to view only statuses with media attachments. | false |
| `only-public` | bool | Set to `true` to view only public statuses. | false |
### Follow an account ### Follow an account
Sends a follow request to the account you want to follow. Sends a follow request to the account you want to follow.