checkpoint: more work on user manual

Add Radicle as a forge (network) that the main branch is mirrored to.

README.md

@@ -18,12 +18,15 @@ At this time it is not recommended for use this with your production GoToSocial
 ### Repository mirrors
 
 Enbas is actively developed in [Code Flow](https://codeflow.dananglin.me.uk/apollo/enbas) with
-the `main` branch mirrored to [Codeberg](https://codeberg.org/dananglin/enbas) and
-[GitHub](https://github.com/dananglin/enbas).
+the `main` branch mirrored to the following forges:
+
+- **Codeberg**: https://codeberg.org/dananglin/enbas
+- **Radicle**: https://app.radicle.xyz/nodes/seed.radicle.garden/rad:zhqv2orTvTh2x2d7kYky9NhctrpK
+- **GitHub**: https://github.com/dananglin/enbas
 
 ### Documentation
 
-- **[Installation guide](./docs/install.md)**: A guide for installing Enbas on your machine.
+- **[Installation guide](./docs/installation.md)**: A guide for installing Enbas on your machine.
 - **[Getting started guide](./docs/getting_started.md)**: A guide to help you get started on using Enbas.
 - **[Configuration reference](./docs/configuration.md)**: The configuration reference documentation.
 - **[User manual](./docs/manual.md)**: The user manual.

docs/manual.md

@@ -6,4 +6,331 @@ SPDX-License-Identifier: CC-BY-4.0
 
 # User Manual
 
-_Coming soon_
+## Version
+
+### Print the application version
+
+View the application's version and build information
+
+```
+enbas version --full
+```
+
+| flag | type | required | description | default |
+|------|------|----------|-------------|---------|
+| `full` | boolean | false | Prints the full build information. | false |
+
+## Authentication
+
+### Logging into an account
+
+Log into your GoToSocial account. You can run this multiple times to log into multiple accounts.
+
+```
+enbas login --instance gts.enbas-demo.private
+```
+
+| flag | type | required | description | default |
+|------|------|----------|-------------|---------|
+| `instance` | string | true | The instance that you wan to log into. | |
+
+### Switch between accounts
+
+Switch between your logged in accounts.
+
+```
+enbas switch --to account --account-name vincent@gts.enbas-demo.private
+```
+
+| flag | type | required | description | default |
+|------|------|----------|-------------|---------|
+| `to` | string | true | The resource you want to switch to. In this case you want `account`. | |
+| `account-name` | string | true | The name of the account you want to switch to. | |
+
+### See the account that you are currently logged in as
+
+```
+enbas whoami
+```
+
+## Accounts
+
+### View your own account
+
+Print the information of your own account.
+
+```
+enbas show --type account --my-account
+```
+
+| flag | type | required | description | default |
+|------|------|----------|-------------|---------|
+| `type` | string | true | The resource you want to view. In this case you want `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 returned.
+
+```
+enbas show --type account --account-name @name@example.social
+```
+
+| flag | type | required | description | default |
+|------|------|----------|-------------|---------|
+| `type` | string | true | The resource you want to view. In this case you want `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 |
+
+### Follow an account
+
+Send a follow request to the account you want to follow.
+
+```
+enbas follow --type account --account-name @name@example.social
+```
+
+| flag | type | required | description | default |
+|------|------|----------|-------------|---------|
+| `type` | string | true | The resource you want to follow. In this case you want `account`. | |
+| `account-name` | string | true | The name of the account to follow. | |
+| `show-reposts` | boolean | false | Show reposts from the account you want to follow. | true |
+| `notify` | boolean | false | Get notifications when the account you want to follow posts a status. | false |
+
+### 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.
+
+```
+enbas unfollow --type account --account-name @name@example.social
+```
+
+| flag | type | required | description | default |
+|------|------|----------|-------------|---------|
+| `type` | string | true | The resource you want to unfollow. In this case you want `account`. | |
+| `account-name` | string | true | The name of the account to unfollow. | |
+
+### Block an account
+
+```
+enbas block --type account --account-name @name@example.social
+```
+
+| flag | type | required | description | default |
+|------|------|----------|-------------|---------|
+| `type` | string | true | The resource you want to block. In this case you want `account`. | |
+| `account-name` | string | true | The name of the account to block. | |
+
+### Unblock an account
+
+```
+enbas unblock --type account --account-name @name@example.social
+```
+
+| flag | type | required | description | default |
+|------|------|----------|-------------|---------|
+| `type` | string | true | The resource you want to unblock. In this case you want `account`. | |
+| `account-name` | string | true | The name of the account to unblock. | |
+
+### View blocked accounts
+
+Print a list of accounts that you are currently blocking.
+
+```
+enbas show --type blocked
+```
+
+| flag | type | required | description | default |
+|------|------|----------|-------------|---------|
+| `type` | string | true | The resource you want to view.<br>Here this should be `blocked` for blocked accounts. | |
+| `limit` | integer | false | The maximum number of accounts to list. | 20 |
+
+### Mute an account
+
+```
+enbas mute --type account --account-name @name@example.social --mute-notifications --mute-duration="1h"
+```
+
+| flag | type | required | description | default |
+|------|------|----------|-------------|---------|
+| `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) |
+
+### Unmute an account
+
+```
+enbas unmute --type account --account-name @name@example.social 
+```
+
+| flag | type | required | description | default |
+|------|------|----------|-------------|---------|
+| `type` | string | true | The resource you want to unmute.<br>Here this should be `account`. | |
+| `account-name` | string | true | The name of the account to unmute. | |
+
+### View muted accounts
+
+Prints a list of accounts that you have muted.
+
+``` 
+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 |
+
+## Statuses
+
+### View a status
+
+### Create a status
+
+- Create a one line status
+- Create a status from a file
+- Create a status with a poll
+
+### Delete a status
+
+_Not yet implemented_
+
+### Boost (Reblog) a status
+
+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.
+
+### 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
+
+### View a poll
+
+### Vote in a poll
+
+## Timelines
+
+## Lists
+
+### 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.<br>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.<br>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.<br>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.<br>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 accounts to 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.<br>Here this should be `account`. | |
+| `account-name` | string | true | The name of the account you want to add to the list.<br>Use multiple times to specify multiple accounts. | |
+| `to` | string | true | The resource you want to add the accounts to.<br>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.<br>Here this should be `account`. | |
+| `account-name` | string | true | The name of the account you want to remove from the list.<br>Use multiple times to specify multiple accounts. | |
+| `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. | |
+
+## 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.<br>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.<br>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.<br>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.<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`. | |

internal/executor/mute_or_unmute.go

@@ -7,6 +7,7 @@ package executor
 import (
 	"flag"
 	"fmt"
+	"time"
 
 	"codeflow.dananglin.me.uk/apollo/enbas/internal/client"
 	"codeflow.dananglin.me.uk/apollo/enbas/internal/config"
@@ -26,12 +27,15 @@ type MuteOrUnmuteExecutor struct {
 }
 
 func NewMuteOrUnmuteExecutor(printer *printer.Printer, config *config.Config, name, summary string) *MuteOrUnmuteExecutor {
+	muteDuration := TimeDurationFlagValue{time.Duration(0 * time.Second)}
+
 	exe := MuteOrUnmuteExecutor{
 		FlagSet: flag.NewFlagSet(name, flag.ExitOnError),
 
 		printer:      printer,
 		config:       config,
 		command:      name,
+		muteDuration: muteDuration,
 	}
 
 	exe.StringVar(&exe.accountName, flagAccountName, "", "Specify the account name in full (username@domain)")

internal/executor/switch.go

@@ -16,16 +16,17 @@ type SwitchExecutor struct {
 	*flag.FlagSet
 
 	config         *config.Config
+	printer        *printer.Printer
 	toResourceType string
 	accountName    string
-	printer        *printer.Printer
 }
 
 func NewSwitchExecutor(printer *printer.Printer, config *config.Config, name, summary string) *SwitchExecutor {
 	switchExe := SwitchExecutor{
 		FlagSet: flag.NewFlagSet(name, flag.ExitOnError),
-		printer: printer,
+
 		config:  config,
+		printer: printer,
 	}
 
 	switchExe.StringVar(&switchExe.toResourceType, flagTo, "", "The account to switch to")