From 79d1713080b813e15fb34b089bf8f3ce415ce901 Mon Sep 17 00:00:00 2001 From: Randall Winkhart Date: Fri, 19 Jul 2024 17:56:42 -0400 Subject: [PATCH] [wiki/MUTN] Add basic setup and usage instructions --- docs/man | 2 +- wiki/MUTN/bugs.md | 2 +- wiki/MUTN/usage.md | 24 ++++++++++++++++++++++++ 3 files changed, 26 insertions(+), 2 deletions(-) create mode 100644 wiki/MUTN/usage.md diff --git a/docs/man b/docs/man index 6539698..12e38dc 100644 --- a/docs/man +++ b/docs/man @@ -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 diff --git a/wiki/MUTN/bugs.md b/wiki/MUTN/bugs.md index d672fdb..94799a6 100644 --- a/wiki/MUTN/bugs.md +++ b/wiki/MUTN/bugs.md @@ -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) diff --git a/wiki/MUTN/usage.md b/wiki/MUTN/usage.md new file mode 100644 index 0000000..23d2def --- /dev/null +++ b/wiki/MUTN/usage.md @@ -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 ` without an entry name or any options. For example, `mutn edit` will display help for the `edit` argument.