timelines, follow requests
This commit is contained in:
parent
62f49bd8bc
commit
3ef3e22489
GPG key ID:
0C1D44CFBEE68638
1 changed files with 127 additions and 9 deletions
136
docs/manual.md
136
docs/manual.md
|
|
@ -8,8 +8,10 @@ SPDX-License-Identifier: CC-BY-4.0
|
|||
|
||||
## Table of Contents
|
||||
|
||||
- [Global flags](#global-flags)
|
||||
- [Version](#version)
|
||||
- [Print the application version](#print-the-application-version)
|
||||
- [Init](#init)
|
||||
- [Authentication](#authentication)
|
||||
- [Logging into an account](#logging-into-an-account)
|
||||
- [Switch between accounts](#switch-between-accounts)
|
||||
|
|
@ -19,12 +21,18 @@ SPDX-License-Identifier: CC-BY-4.0
|
|||
- [View an account](#view-an-account)
|
||||
- [Follow an account](#follow-an-account)
|
||||
- [Unfollow an account](#unfollow-an-account)
|
||||
- [Show followers of an account](#show-followers-of-an-account)
|
||||
- [Show who an account is following](#show-who-an-account-is-following)
|
||||
- [Block an account](#block-an-account)
|
||||
- [Unblock an account](#unblock-an-account)
|
||||
- [View blocked accounts](#view-blocked-accounts)
|
||||
- [Mute an account](#mute-an-account)
|
||||
- [Unmute an account](#unmute-an-account)
|
||||
- [View muted accounts](#view-muted-accounts)
|
||||
- [Follow requests](#follow-requests)
|
||||
- [View your follow requests](#view-your-follow-requests)
|
||||
- [Accept a follow request](#accept-a-follow-request)
|
||||
- [Reject a follow request](#reject-a-follow-request)
|
||||
- [Statuses](#statuses)
|
||||
- [View a status](#view-a-status)
|
||||
- [Create a status](#create-a-status)
|
||||
|
|
@ -33,10 +41,12 @@ SPDX-License-Identifier: CC-BY-4.0
|
|||
- [Un-boost (Un-repost) a status](#un-boost-un-repost-a-status)
|
||||
- [Like a status](#like-a-status)
|
||||
- [Unlike a status](#unlike-a-status)
|
||||
- [Mute a status](#mute-a-status)
|
||||
- [Unmute a status](#unmute-a-status)
|
||||
- [Polls](#polls)
|
||||
- [Create a poll](#create-a-poll)
|
||||
- [View a poll](#view-a-poll)
|
||||
- [Vote in a poll](#vote-in-a-poll)
|
||||
- [Timelines](#timelines)
|
||||
- [Lists](#lists)
|
||||
- [Create a list](#create-a-list)
|
||||
- [View a list of your lists](#view-a-list-of-your-lists)
|
||||
|
|
@ -45,10 +55,22 @@ SPDX-License-Identifier: CC-BY-4.0
|
|||
- [Delete a list](#delete-a-list)
|
||||
- [Add accounts to a list](#add-accounts-to-a-list)
|
||||
- [Remove accounts from a list](#remove-accounts-from-a-list)
|
||||
- [Timelines](#timelines)
|
||||
- [View a timeline](#view-a-timeline)
|
||||
- [Media](#media)
|
||||
- [View media from a status](#view-media-from-a-status)
|
||||
- [Bookmarks](#bookmarks)
|
||||
- [View your bookmarks](#view-your-bookmarks)
|
||||
- [Add a status to your bookmarks](#add-a-status-to-your-bookmarks)
|
||||
- [Remove a status from your bookmarks](#remove-a-status-from-your-bookmarks)
|
||||
- [Notifications](#notifications)
|
||||
|
||||
## Global flags
|
||||
|
||||
| flag | type | required | description | default |
|
||||
|------|------|----------|-------------|---------|
|
||||
| `config-dir` | string | false | The configuration directory. | |
|
||||
| `no-color` | boolean | false | Disables ANSI colour output when displaying text on screen<br>You can also set `NO_COLOR` to any value for the same effect. | false |
|
||||
|
||||
## Version
|
||||
|
||||
|
|
@ -64,6 +86,15 @@ enbas version --full
|
|||
|------|------|----------|-------------|---------|
|
||||
| `full` | boolean | false | Prints the full build information. | false |
|
||||
|
||||
## Init
|
||||
|
||||
Initialises the app by creating a configuration file in the configuration directory.
|
||||
If you want to use a specific directory then use the global `--config-dir` flag.
|
||||
|
||||
```
|
||||
enbas init
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
### Logging into an account
|
||||
|
|
@ -158,6 +189,15 @@ 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
|
||||
|
||||
_TODO: provide instructions after updated implementation_
|
||||
|
||||
### Show who an account is following
|
||||
|
||||
_TODO: provide instructions after updated implementation_
|
||||
|
||||
|
||||
### Block an account
|
||||
|
||||
```
|
||||
|
|
@ -204,7 +244,7 @@ enbas mute --type account --account-name @name@example.social --mute-notificatio
|
|||
| `type` | string | true | The resource you want to mute.<br>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.<br>Set to `0s` to mute indefinitely | 0s (indefinitely) |
|
||||
| `mute-duration` | string | false | Specify how long the account should be muted for.<br>Set to `0s` to mute indefinitely | 0s (indefinitely). |
|
||||
|
||||
### Unmute an account
|
||||
|
||||
|
|
@ -228,7 +268,44 @@ enbas show --type muted-accounts
|
|||
| flag | type | required | description | default |
|
||||
|------|------|----------|-------------|---------|
|
||||
| `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 list. | 20 |
|
||||
| `limit` | integer | false | The maximum number of accounts to print. | 20 |
|
||||
|
||||
## Follow requests
|
||||
|
||||
### View your follow requests
|
||||
|
||||
Prints a list of accounts that are requesting to follow you.
|
||||
|
||||
```
|
||||
enbas show --type follow-request
|
||||
```
|
||||
|
||||
| flag | type | required | description | default |
|
||||
|------|------|----------|-------------|---------|
|
||||
| `type` | string | true | The resource you want to view.<br>Here this should be `follow-request`. | |
|
||||
| `limit` | integer | false | The maximum number of accounts to print. | 20 |
|
||||
|
||||
### Accept a follow request
|
||||
|
||||
```
|
||||
enbas accept --type follow-request --account-name @person.example.social
|
||||
```
|
||||
|
||||
| flag | type | required | description | default |
|
||||
|------|------|----------|-------------|---------|
|
||||
| `type` | string | true | The resource you want to accept.<br>Here this should be `follow-request`. | |
|
||||
| `account-name` | string | true | The name of the account that you want to accept. | |
|
||||
|
||||
### Reject a follow request
|
||||
|
||||
```
|
||||
enbas reject --type follow-request --account-name @person.example.social
|
||||
```
|
||||
|
||||
| flag | type | required | description | default |
|
||||
|------|------|----------|-------------|---------|
|
||||
| `type` | string | true | The resource you want to accept.<br>Here this should be `follow-request`. | |
|
||||
| `account-name` | string | true | The name of the account that you want to reject. | |
|
||||
|
||||
## Statuses
|
||||
|
||||
|
|
@ -260,6 +337,14 @@ To like (favourite) a status you simply add a `like` or a `star` to it.
|
|||
|
||||
To unlike (un-favourite) a status that you've previously liked you simply remove the `like` or `star` from it.
|
||||
|
||||
### Mute a status
|
||||
|
||||
_Not yet supported_
|
||||
|
||||
### Unmute a status
|
||||
|
||||
_Not yet supported_
|
||||
|
||||
## Polls
|
||||
|
||||
### Create a poll
|
||||
|
|
@ -294,12 +379,6 @@ enbas add --type vote --to poll --poll-id 01J1TVJ705VV3VP02FVVBSMX7E --choose 3
|
|||
| `poll-id` | string | true | The ID of the poll you want to add the votes to. | |
|
||||
| `choose` | int | true | The ID of the option that you want to vote for.<br>You can use this flag multiple times to vote for more than one option if the poll allows multiple choices. | |
|
||||
|
||||
## Media
|
||||
|
||||
### View media from a status
|
||||
|
||||
## Timelines
|
||||
|
||||
## Lists
|
||||
|
||||
### Create a list
|
||||
|
|
@ -394,6 +473,41 @@ enbas remove --type account --account-name @person@mastodon.example --from list
|
|||
| `to` | string | true | The resource you want to remove the accounts from.<br>Here this should be `list`. | |
|
||||
| `list-id` | string | true | The ID of the list that you want to remove the accounts from. | |
|
||||
|
||||
## Timelines
|
||||
|
||||
### View a timeline
|
||||
|
||||
Prints a list of statuses from a timeline.
|
||||
|
||||
- View your home timeline.
|
||||
```
|
||||
enbas show --type timeline --timeline-category home
|
||||
```
|
||||
- View a maximum of 5 statuses from your instance's public timeline.
|
||||
```
|
||||
enbas show --type timeline --timeline-category public --limit 5
|
||||
```
|
||||
- View a timeline from one of your lists.
|
||||
```
|
||||
enbas show --type timeline --timeline-category list --list-id 01J1T9DWR20DC36QWZFKHWZJ3H
|
||||
```
|
||||
- View a timeline from a hashtag.
|
||||
```
|
||||
enbas show --type timeline --timeline-category tag --tag caturday
|
||||
```
|
||||
|
||||
| flag | type | required | description | default |
|
||||
|------|------|----------|-------------|---------|
|
||||
| `type` | string | true | The resource you want to view.<br>Here this should be `timeline`. | |
|
||||
| `timeline-category` | string | false | The type of timeline you want to view.<br>Valid values are `home`, `public`, `list` and `tag`. | home |
|
||||
| `list-id` | string | false | The ID of the list you want to view.<br>This is only required if `timeline-category` is set to `list`. | |
|
||||
| `tag` | string | false | The hashtag you want to view.<br>This is only required if `timeline-category` is set to `tag`. | |
|
||||
| `limit` | integer | false | The maximum number of statuses to print. | 20 |
|
||||
|
||||
## Media
|
||||
|
||||
### View media from a status
|
||||
|
||||
## Bookmarks
|
||||
|
||||
### View your bookmarks
|
||||
|
|
@ -432,3 +546,7 @@ enbas remove --type status --status-id 01J17FH1KD9CN6J9Q01011NE0D --from bookmar
|
|||
| `type` | string | true | The resource you want to remove.<br>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.<br>Here this should be `bookmarks`. | |
|
||||
|
||||
## Notifications
|
||||
|
||||
_Not yet supported_
|
||||
|
|
|
|||
Loading…
Reference in a new issue