Skip to content

Commit

Permalink
added first draft of --dm
Browse files Browse the repository at this point in the history
  • Loading branch information
8go committed Dec 5, 2022
1 parent 1e3e75b commit 786ac1a
Show file tree
Hide file tree
Showing 8 changed files with 325 additions and 28 deletions.
14 changes: 7 additions & 7 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[package]
name = "nostr-commander"
version = "0.0.1"
version = "0.0.2"
edition = "2021"
description = "simple but convenient CLI-based Nostr client app for publishing,sending and subscribing"
documentation = "https://docs.rs/nostr-commander"
Expand Down
22 changes: 15 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,16 @@ https://img.shields.io/crates/v/nostr-commander
https://img.shields.io/crates/d/nostr-commander
)](https://crates.io/crates/nostr-commander)

<p>
<img
src="https://raw.githubusercontent.com/8go/nostr-commander-rs/master/logos/nostr-commander-rs.svg"
alt="NC logo" height="150">

# nostr-commander-rs
simple but convenient CLI-based Nostr client app for publishing, sending DMs, as well as following users and channels

nostr-commander is a simple terminal-based CLI client of
Nostr <https://github.com/nostr-protocol>. It lets you create a
Nostr <https://github.com/nostr-protocol/nostr>. It lets you create a
Nostr user, subscribe and follow posts of other
users, send encrypted, private DMs to your Nostr friends,
and much more.
Expand Down Expand Up @@ -125,9 +130,12 @@ Options:
--publish-pow [<NOTE>...]
Publish one or multiple notes with proof-of-work (POW). Use also
'--pow-difficulty' to specify difficulty
--dm [<NOTE>...]
Send one or multiple DMs. DM messages will be encrypted and preserve
privacy
--dm [<ARGS>...]
Send one or multiple DMs to one given user. DM messages will be
encrypted and preserve privacy. The single recipient is specified via
its public key, a string in the form of 'npub1...'. The first
argument is the recipient key, als further arguments are texts to be
sent. E.g. '-dm 'npub1SomeStrangeNumbers "First msg" "Second msg"'
--add-relay [<RELAY_URI>...]
Add one or multiple relays. A relay is specified via a URI that looks
like 'wss://some.relay.org'. You can find relays by looking at
Expand All @@ -152,9 +160,9 @@ Options:
--show-secret-key
Show private, secret key. Protect this key
--whoami
Print the user name used by "matrix-commander-rs" (itself). One can
get this information also by looking at the credentials file or by
using --show-metadata
Print the user name used by "nostr-commander-rs". One can get this
information also by looking at the credentials file or by using
--show-metadata
-o, --output <OUTPUT_FORMAT>
This option decides on how the output is presented. Currently offered
choices are: 'text', 'json', 'json-max', and 'json-spec'. Provide one
Expand Down
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
0.0.1
0.0.2
15 changes: 9 additions & 6 deletions help.txt
Original file line number Diff line number Diff line change
Expand Up @@ -89,9 +89,12 @@ Options:
--publish-pow [<NOTE>...]
Publish one or multiple notes with proof-of-work (POW). Use also
'--pow-difficulty' to specify difficulty
--dm [<NOTE>...]
Send one or multiple DMs. DM messages will be encrypted and preserve
privacy
--dm [<ARGS>...]
Send one or multiple DMs to one given user. DM messages will be
encrypted and preserve privacy. The single recipient is specified via
its public key, a string in the form of 'npub1...'. The first
argument is the recipient key, als further arguments are texts to be
sent. E.g. '-dm 'npub1SomeStrangeNumbers "First msg" "Second msg"'
--add-relay [<RELAY_URI>...]
Add one or multiple relays. A relay is specified via a URI that looks
like 'wss://some.relay.org'. You can find relays by looking at
Expand All @@ -116,9 +119,9 @@ Options:
--show-secret-key
Show private, secret key. Protect this key
--whoami
Print the user name used by "matrix-commander-rs" (itself). One can
get this information also by looking at the credentials file or by
using --show-metadata
Print the user name used by "nostr-commander-rs". One can get this
information also by looking at the credentials file or by using
--show-metadata
-o, --output <OUTPUT_FORMAT>
This option decides on how the output is presented. Currently offered
choices are: 'text', 'json', 'json-max', and 'json-spec'. Provide one
Expand Down
253 changes: 253 additions & 0 deletions logos/nostr-commander-rs.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion scripts/workflow-outline.txt
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ cargo run --release

# generate documentation
cargo doc
firefox target/doc/matrix_commander/index.html
firefox target/doc/nostr_commander/index.html

git status
git commit -a
Expand Down
Loading

0 comments on commit 786ac1a

Please sign in to comment.