diff --git a/docs/manual.md b/docs/manual.md index a4b16c4..57da050 100644 --- a/docs/manual.md +++ b/docs/manual.md @@ -71,8 +71,8 @@ enbas show --type account --my-account ### View an account -Print the information of a local or a remote account. If the account is unknown by your instance a `404` message -will be returned. +Prints the information of a local or a remote account. +If the account is unknown by your instance a `404` message will be returned. ``` enbas show --type account --account-name @name@example.social @@ -101,8 +101,8 @@ 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 following. +If you have a pending follow request to the account in question, unfollowing will remove the follow request. ``` enbas unfollow --type account --account-name @name@example.social @@ -145,7 +145,7 @@ enbas show --type blocked | flag | type | required | description | default | |------|------|----------|-------------|---------| -| `type` | string | true | The resource you want to view. In this case you want `blocked` for blocked accounts. | | +| `type` | string | true | The resource you want to view.
Here this should be `blocked` for blocked accounts. | | | `limit` | integer | false | The maximum number of accounts to list. | 20 | ### Mute an account @@ -156,10 +156,10 @@ enbas mute --type account --account-name @name@example.social --mute-notificatio | flag | type | required | description | default | |------|------|----------|-------------|---------| -| `type` | string | true | The resource you want to mute. In this case you want `account`. | | +| `type` | string | true | The resource you want to mute.
Here this should be `account`. | | | `account-name` | string | true | The name of the account to mute. | | | `mute-notifications` | boolean | false | Set to `true` to mute notifications as well as statuses. | false | -| `mute-duration` | string | false | Specify how long the account should be muted for. Set to `0s` to mute indefinitely | 0s (indefinitely) | +| `mute-duration` | string | false | Specify how long the account should be muted for.
Set to `0s` to mute indefinitely | 0s (indefinitely) | ### Unmute an account @@ -169,12 +169,12 @@ enbas unmute --type account --account-name @name@example.social | flag | type | required | description | default | |------|------|----------|-------------|---------| -| `type` | string | true | The resource you want to unmute. In this case you want `account`. | | +| `type` | string | true | The resource you want to unmute.
Here this should be `account`. | | | `account-name` | string | true | The name of the account to unmute. | | ### View muted accounts -Print a list of accounts that you have muted. +Prints a list of accounts that you have muted. ``` enbas show --type muted-accounts @@ -182,7 +182,7 @@ enbas show --type muted-accounts | flag | type | required | description | default | |------|------|----------|-------------|---------| -| `type` | string | true | The resource you want to view. In this case you want `muted-accounts`. | | +| `type` | string | true | The resource you want to view.
Here this should be `muted-accounts`. | | | `limit` | integer | false | The maximum number of accounts to list. | 20 | ## Statuses @@ -191,7 +191,9 @@ enbas show --type muted-accounts ### Create a status -### Create a status with a poll +- Create a one line status +- Create a status from a file +- Create a status with a poll ### Delete a status @@ -199,13 +201,19 @@ _Not yet implemented_ ### Boost (Reblog) a status -To boost a status you simply add a 'boost' to it. +To boost a status you simply add a `boost` to it. ### Un-boost (Un-reblog) a status -To un-boost a status that you've boosted you simply remove the 'boost' from it. +To un-boost a status that you've boosted you simply remove the `boost` from it. -### Like/Star/Favourite a status +### Like a status + +To like (favourite) a status you simply add a `like` or a `star` to it. + +### Unlike a status + +To unlike (un-favourite) a status that you've previously liked you simply remove the `like` or `star` from it. ## Polls @@ -219,16 +227,110 @@ To un-boost a status that you've boosted you simply remove the 'boost' from it. ### Create a list +``` +enbas create --type list --list-title "My Favourite People" --list-replies-policy list +``` + +| flag | type | required | description | default | +|------|------|----------|-------------|---------| +| `type` | string | true | The resource you want to create.
Here this should be `list`. | | +| `list-title` | string | true | The title of the list that you want to create. | | +| `list-replies-policy` | string | false | The policy of the replies for this list.
Valid values are `followed`, `list` and `none`. | list | + +### View a list of your lists + +``` +enbas show --type list +``` + +| flag | type | required | description | default | +|------|------|----------|-------------|---------| +| `type` | string | true | The resource you want to view.
Here this should be `list`. | | + +### View a specific list + +Prints the information of the specified list to screen along with all the accounts added to it (if any). + +``` +enbas show --type list --list-id 01J1T9DWR20DC36QWZFKHWZJ3H +``` + +| flag | type | required | description | default | +|------|------|----------|-------------|---------| +| `type` | string | true | The resource you want to view.
Here this should be `list`. | | +| `list-id` | string | false | The ID of the list you want to view. If this is not specified then a list of your lists will be printed instead. | | + ### Edit a list +_Potentially a bug here_ + ### Delete a list -### Add an account to a list +### Add accounts to a list -### Remove an account from a list +Adds one or more accounts to a list. + +``` +enbas add --type account --account-name @name@example.social --account-name @person@mastodon.example --to list --list-id 01J1T9DWR20DC36QWZFKHWZJ3H +``` + +| flag | type | required | description | default | +|------|------|----------|-------------|---------| +| `type` | string | true | The resource you want to add.
Here this should be `account`. | | +| `account-name` | string | true | The name of the account you want to add to the list.
Use multiple times to specify multiple accounts. | | +| `to` | string | true | The resource you want to add the accounts to.
Here this should be `list`. | | +| `list-id` | string | true | The ID of the list that you want to add the accounts to. | | + +### Remove accounts from a list + +Remove one or more accounts from a list. + +``` +enbas remove --type account --account-name @person@mastodon.example --from list --list-id 01J1T9DWR20DC36QWZFKHWZJ3H +``` + +| flag | type | required | description | default | +|------|------|----------|-------------|---------| +| `type` | string | true | The resource you want to add.
Here this should be `account`. | | +| `account-name` | string | true | The name of the account you want to remove from the list.
Use multiple times to specify multiple accounts. | | +| `to` | string | true | The resource you want to remove the accounts from.
Here this should be `list`. | | +| `list-id` | string | true | The ID of the list that you want to remove the accounts from. | | ## Bookmarks +### View your bookmarks + +Prints a list of statuses that you have bookmarked. + +``` +enbas show --type bookmarks +``` + +| flag | type | required | description | default | +|------|------|----------|-------------|---------| +| `type` | string | true | The resource you want to view.
Here this should be `bookmarks`. | | +| `limit` | integer | false | The maximum number of bookmarks to show. | 20 | + ### Add a status to your bookmarks +``` +enbas add --type status --status-id 01J17FH1KD9CN6J9Q01011NE0D --to bookmarks +``` + +| flag | type | required | description | default | +|------|------|----------|-------------|---------| +| `type` | string | true | The resource you want to add.
Here this should be `status`. | | +| `status-id` | string | true | The ID of the status. | | +| `to` | string | true | The resource you want to add the status to.
Here this should be `bookmarks`. | | + ### Remove a status from your bookmarks + +``` +enbas remove --type status --status-id 01J17FH1KD9CN6J9Q01011NE0D --from bookmarks +``` + +| flag | type | required | description | default | +|------|------|----------|-------------|---------| +| `type` | string | true | The resource you want to remove.
Here this should be `status`. | | +| `status-id` | string | true | The ID of the status. | | +| `from` | string | true | The resource you want to remove the status to.
Here this should be `bookmarks`. | |