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

checkpoint: list section complete

Browse source
This commit is contained in:
Dan Anglin 2024-07-02 20:50:02 +01:00
parent a8e818c4dd
commit 787101d860
Signed by: dananglin
GPG key ID: 0C1D44CFBEE68638
1 changed files with 29 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
docs/manual.md
View file

@ -101,8 +101,9 @@ enbas follow --type account --account-name @name@example.social
### Unfollow an account
Unfollow the account that you are following.
If you have a pending follow request to the account in question, unfollowing will remove the follow request.
Unfollow the account that you are currently following.
If you have a follow request pending for the account in question,
performing an unfollow action will remove said follow request.
```
enbas unfollow --type account --account-name @name@example.social
@ -137,7 +138,7 @@ enbas unblock --type account --account-name @name@example.social
### View blocked accounts
Print a list of accounts that you are currently blocking.
Prints a list of accounts that you are currently blocking.
```
enbas show --type blocked
@ -199,11 +200,11 @@ enbas show --type muted-accounts
_Not yet implemented_
### Boost (Reblog) a status
### Boost (Repost) a status
To boost a status you simply add a `boost` to it.
### Un-boost (Un-reblog) a status
### Un-boost (Un-repost) a status
To un-boost a status that you've boosted you simply remove the `boost` from it.
@ -262,10 +263,31 @@ enbas show --type list --list-id 01J1T9DWR20DC36QWZFKHWZJ3H
### Edit a list
_Potentially a bug here_
Edits the title and/or the replies policy of a list.
```
enbas edit --type list --list-id 01J1T9DWR20DC36QWZFKHWZJ3H --list-title "My Favourite People (in the world)"
```
| flag | type | required | description | default |
|------|------|----------|-------------|---------|
| `type` | string | true | The resource you want to edit.<br>Here this should be `list`. | |
| `list-title` | string | false | The title of the list that you want to edit. | |
| `list-replies-policy` | string | false | The policy of the replies for this list that you want to change to.<br>Valid values are `followed`, `list` and `none`. | |
### Delete a list
Deletes a list.
```
enbas delete --type list --list-id 01J1T9DWR20DC36QWZFKHWZJ3H
```
| flag | type | required | description | default |
|------|------|----------|-------------|---------|
| `type` | string | true | The resource you want to delete.<br>Here this should be `list`. | |
| `list-id` | string | true | The ID of the list you want to delete. | |
### Add accounts to a list
Adds one or more accounts to a list.
@ -283,7 +305,7 @@ enbas add --type account --account-name @name@example.social --account-name @per
### Remove accounts from a list
Remove one or more accounts from a list.
Removes one or more accounts from a list.
```
enbas remove --type account --account-name @person@mastodon.example --from list --list-id 01J1T9DWR20DC36QWZFKHWZJ3H