7 releases
0.3.0 | Oct 13, 2024 |
---|---|
0.2.4 | Oct 10, 2024 |
0.1.0 | Oct 3, 2024 |
#240 in Command line utilities
649 downloads per month
26KB
415 lines
Memos CLI
A command-line tool for Memos.
Installation
Use Cargo to install the application.
cargo install memos-cli
Usage
memo [OPTIONS] [COMMAND]
Login
To enable all features you must first log in to your Memos server. Use the following command to log into your server:
memo login
Create a new memo
Once logged in you can create a new memo by running the command without any options.
memo
This will open your default editor as defined in VISUAL
or EDITOR
.
[!IMPORTANT]
Make sure you save the memo before closing the editor.
After closing the editor your memo will be saved to your server.
Visibility
By default your memo's visibility will be set to "Private". You can set the visibility to "Workspace" using the following option:
memo --workspace
Or "Public" using this option:
memo --public
Reading input from STDIN
It is also possible to set the content for the memo from STDIN
. To do this
just pipe your content into the command:
echo "Hello" | memo
Skipping the editor
When using content from STDIN
you might not need to use the editor. To skip
editing use the following option:
memo --no-edit
List memos
To display a list of all your memos use the following command:
memo list
Known issues
- When using Visual Studio Code as
VISUAL
it needs to wait for the file to be closed before returning. To make this happen you need to add the--wait
option to thecode
command. - The application uses an API client generated from the API specification. This may in some cases result in memos not being displayed due to missing definitions in the specification.
Dependencies
~17–31MB
~487K SLoC