[wiki/MUTN] Add basic setup and usage instructions

This commit is contained in:
2024-07-19 17:56:42 -04:00
parent 35192fa568
commit 3a1ca0b68d
5 changed files with 28 additions and 4 deletions
+1 -1
View File
@@ -93,7 +93,7 @@ libmutton operates on a client-server model, and thus sync support requires you
For security reasons, libmutton deliberately does not support password-based SSH authentication; you must use key-based authentication to connect to your server (password-protected keys are also supported). You are responsible for setting up SSH connectivity on your own.
The libmutton server software is shipped as its own dedicated binary and must be installed and configured on the server.
The libmutton server software is shipped as its own dedicated binary and must be installed on the server and configured with "libmuttonserver init".
Once this has been done, you may proceed with the client setup:
1. Install MUTN
+1 -1
View File
@@ -1,4 +1,4 @@
# Known Bugs - MUTN CLI
## Known Bugs - MUTN CLI
- Various Markdown issues resulting from the use of [Glamour](https://github.com/charmbracelet/glamour)
- [Odd handling of line breaks](https://github.com/charmbracelet/glamour/issues/84)
- [Broken quotes](https://github.com/charmbracelet/glamour/issues/172) (seems related to line break issue)
+24
View File
@@ -0,0 +1,24 @@
## Setup/Usage Tips - MUTN CLI
Most information relevant to the usage of MUTN can be viewed with `mutn help`, in [the man page](https://raw.githubusercontent.com/rwinkhart/MUTN/main/docs/man), and in the demo animation from the README.
Because of this, this wiki page will focus on initial setup as well as some tips that may not be immediately obvious.
### Initial Setup
libmutton operates on a client-server model, and thus sync support requires you to have access to your own server (whether it be a physical home server or a cloud rental) with remote access via SSH.
For security reasons, libmutton deliberately does not support password-based SSH authentication; you must use key-based authentication to connect to your server (password-protected keys are also supported). You are responsible for setting up SSH connectivity on your own.
The libmutton server software is shipped as its own dedicated binary and must be installed on the server and configured with `libmuttonserver init`.
Once this has been done, you may proceed with the client setup:
1. Install MUTN
2. Run `mutn init` and follow the prompts
3. If you already have entries on the server, sync them using `mutn sync`
4. Optionally, shell completions (Bash, ZSH, and PowerShell 7+) can be [enabled with your shell's respective method](https://github.com/rwinkhart/MUTN/blob/main/wiki/MUTN/completions.md)
### Tips
#### Operating on Passwords
Any action that operates on the password attached to an entry (copying, editing, adding a new password-focused entry) does not require the user to specify the `password` or `-pw` options. In all cases, `password` is the assumed target when no other option is specified.
#### Granular Help
Argument-specific help can be obtained by running `mutn <argument>` without an entry name or any options. For example, `mutn edit` will display help for the `edit` argument.
+1 -1
View File
@@ -1,4 +1,4 @@
# Known Bugs - libmutton
## Known Bugs - libmutton
- On Windows, GPG is sometimes (seems unpredictable) incredibly slow to start (often after a reboot), leading to many operations seemingly hanging
- **This will be addressed** in the migration off of GPG that will take place before v1.0.0
- If a client is reconfigured to use a new device ID, the old one will remain present on the server. This will not cause any immediate issues, however it will lead to the server creating unnecessary deletions files for the old device ID. Currently, it is recommended to manually delete the old device ID from the server's "devices" directory.
+1 -1
View File
@@ -7,7 +7,7 @@ Crossed out items have not yet been added to the wiki.
[Building](https://github.com/rwinkhart/MUTN/blob/main/wiki/MUTN/build.md)
[~~Usage~~](https://github.com/rwinkhart/MUTN/blob/main/wiki/MUTN/usage.md)
[Setup/Usage](https://github.com/rwinkhart/MUTN/blob/main/wiki/MUTN/usage.md)
[Shell Completions Troubleshooting](https://github.com/rwinkhart/MUTN/blob/main/wiki/MUTN/completions.md)