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

private note

Browse source
This commit is contained in:
Dan Anglin 2024-07-03 13:16:41 +01:00
parent 3ef3e22489
commit cfe6fe3e8d
Signed by: dananglin
GPG key ID: 0C1D44CFBEE68638
1 changed files with 31 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
docs/manual.md
View file

@ -147,7 +147,7 @@ enbas show --type account --my-account
### 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 returned.
If the account is unknown by your instance a `404` message will be shown instead.
```
enbas show --type account --account-name @name@example.social
@ -157,7 +157,7 @@ enbas show --type account --account-name @name@example.social
|------|------|----------|-------------|---------|
| `type` | string | true | The resource you want to view. Here this should be `account`. | |
| `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. | 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 |
### Follow an account
@ -189,15 +189,14 @@ enbas unfollow --type account --account-name @name@example.social
| `type` | string | true | The resource you want to unfollow. Here this should be `account`. | |
| `account-name` | string | true | The name of the account to unfollow. | |
### Show followers of an account
### Show an account's followers
_TODO: provide instructions after updated implementation_
### Show who an account is following
### Show account's followings
_TODO: provide instructions after updated implementation_
### Block an account
```
@ -270,6 +269,33 @@ enbas show --type muted-accounts
| `type` | string | true | The resource you want to view.<br>Here this should be `muted-accounts`. | |
| `limit` | integer | false | The maximum number of accounts to print. | 20 |
### Add a private note to an account
Adds a private note to an account. Private notes can only be viewed by you.
```
enbas add --type note --to account --account-name @name@example.social --content "This person is awesome."
```
| flag | type | required | description | default |
|------|------|----------|-------------|---------|
| `type` | string | true | The resource you want to add.<br>Here this should be `note`. | |
| `to` | string | true | The resource you want to add the note to.<br>Here this should be `account`. | |
| `account-name` | string | true | The name of the account that you want to add the note to. | |
| `content` | string | true | The content of the note. | |
### Remove the private note from an account
```
enbas remove --type note --from account --account-name @name@example.social
```
| flag | type | required | description | default |
|------|------|----------|-------------|---------|
| `type` | string | true | The resource you want to remove.<br>Here this should be `note`. | |
| `from` | string | true | The resource you want to remove the note to.<br>Here this should be `account`. | |
| `account-name` | string | true | The name of the account that you want to remove the note from. | |
## Follow requests
### View your follow requests