Home

Awesome

nostk

Implementing a CLI client to use Nostr Protocol.

Develop Environment

Features

ToDo

Requirements

Setup

Install tools

  1. Install git
  2. Install golang

Install nostk:

Windows
SETX EDITOR=<Text editor's full path name>
go install github.com/mitsugu/nostk@<tag name>
Ubuntu and maybe other distribution

For bash

echo 'export EDITOR=vim' >> ~/.bashrc
go install github.com/mitsugu/nostk@<tag name>

Placement of config.json

IF config.json NOT FOUND IN .nostk DIRECTORY, EXECUTE THE FOLLOWING.

  1. Download config.json
  2. Move config.json to "$HOME/.nostk" directory
  3. Adjust defaultReadNo, multiplierReadRelayWaitTime, and defaultContentWarning in config.json to your liking.

Setting nostk:

  1. nostk init (must)
  2. nostk genkey (must)
  3. nostk editRelays (must)
  4. nostk editContacts (must)
  5. nostk editProfile (should *)
  6. nostk pubProfile (should *)
  7. nostk editEmoji (Optional)
  8. nostk pubRelays (Optional)

* Unless there is a special reason, it is recommended to use a web app such as nostter instead of nostk.

Usage

Display help documanets

nostk help

nostk -h

nostk --help

nostk

Init nostk

nostk init

Ganerate Key Pair

nostk genkey

Edit contact list

nostk editContacts

Edit custom emoji

nostk editEmoji

Edit relay list

nostk editRelays

Publish relay list

nostk pubRelays

Edit profile

nostk editProfile

Publish profile

nostk pubProfile

Publish message

nostk pubMessage <text message> [reason of content warning]

nostk pubMessage < (ps)

(ps) | nostk pubMessage

Publish message to

nostk pubMessageTo <text message> <hex pubkey of send to user>

Display home timeline (kind 1, default uninclude content warning)

nostk catHome [number]

Display MSFW timeline (kind 1, default include content warning)

nostk catNSFW [number]

Display your's note (kind 1)

nostk catSelf [number]

Display specified event

nostk catEvent <Hex event id>

Remove specified event (Test implementation)

nostk removeEvent <Hex event id> [reason]

Custom emoji reaction (Test implementation)

nostk emojiReaction <Hex event id> <Hex pubkey> <short code of custom emoji>

About content warning note

The catHome subcommand does not directly display notes with content warnings.

The corresponding note will be printed to indicate that it is a content warning note, the reason will be displayed if a reason is set, and the event ID of the note will also be displayed.
To display a content warning note, run the catEvent subcommand by specifying the note's Event ID in hex.

.vimrc sample code to call from vim

" Usage
"   1. Write content current buffer
"   2. execute next command on command-line
"      : NPublishMessage [reason]
"        If reason is given as an argument,
"          it will be published as a content warning note.
"
command! -nargs=? NPublishMessage call Pubmessage(<f-args>)
function Pubmessage(...)
	if a:0 >= 1
		let l:buffer_contents = join(getline(1, '$'), "\n")
		let l:command = "nostk pubMessage \"" . l:buffer_contents . "\" " . a:1
		let l:command_output = system(l:command)
		echo l:command_output
	else
		w ! nostk pubMessage
	end
endfunction

" Usage
"   execute next command on command-line
"      : NCathome [number]
"        If you pass number as an argument,
"          it will ask the relay to subscribe to number notes.
"
command! -nargs=? NCathome call Cathome(<f-args>)
function! Cathome(...)
	if a:0 >= 1
		let l:command = "nostk catHome " . a:1 . " | jq '.'"
		let l:command_output = system(l:command)
		call append('$', split(l:command_output, "\n"))
	else
		r! nostk catHome | jq '.'
	end
	set ft=json
endfunction

" Usage
"   execute next command on command-line
"      : NCatnsfw [number]
"        If you pass number as an argument,
"          it will ask the relay to subscribe to number notes.
"
command! -nargs=? NCatnsfw call Catnsfw(<f-args>)
function! Catnsfw(...)
	if a:0 >= 1
		let l:command = "nostk catNSFW " . a:1 . " | jq '.'"
		let l:command_output = system(l:command)
		call append('$', split(l:command_output, "\n"))
	else
		r! nostk catNSFW | jq '.'
	end
	set ft=json
endfunction

" Usage
"   execute next command on command-line
"      : NCatself [number]
"        If you pass number as an argument,
"          it will ask the relay to subscribe to number notes.
"
command! -nargs=? NCatself call Catself(<f-args>)
function! Catself(...)
	if a:0 >= 1
		let l:command = "nostk catSelf " . a:1 . " | jq '.'"
		let l:command_output = system(l:command)
		call append('$', split(l:command_output, "\n"))
	else
		r! nostk catSelf | jq '.'
	end
	set ft=json
endfunction

" Usage
"   execute next command on command-line
"      : NRemoveEvent <Event Id> [reason]
"        Event Id : Specify the Event ID to be deleted
"        reason   : Specify the reason for deletion. Reason is optional.
"
command! -nargs=1 NRemoveEvent call Removeevent(<f-args>)
function! Removeevent(...)
	let l:command = "nostk removeEvent "
	for arg in a:000
		let l:command .= arg
	endfor
	let l:command_output = system(l:command)
	echo l:command_output
endfunction

" Usage
"   1. Move the cursor to the EVENT ID of the post you want to react to
"      in the nostk log DISPLAYED IN THE CURRENT BUFFER.
"   2. execute next command on command-line
"      : NEmojireaction <custom emoji short code>
"        custom emoji short code : Specify a custom emoji shortcode
"
command! -nargs=1 NEmojireaction call Emojireaction(<f-args>)
function! Emojireaction(stremoji)
	let l:topline = line('.')
	let l:btmline = l:topline + 3
	let l:lines = getline(l:topline, l:btmline)
	let l:lines_text = join(lines, "\n")
	try
		let l:json_data = json_decode("{" . l:lines_text . "}}")
		let l:keys = keys(l:json_data)
		let l:eventId = l:keys[0]
		let l:data = l:json_data[l:eventId]
		let l:pubkey = l:data.pubkey
	catch
		echoerr "Invalid JSON in selected range."
	endtry
	let l:cmd = 'nostk emojiReaction ' . l:eventId . " " . l:pubkey . ' "' . a:stremoji . '"'
	let l:command_output = system(l:cmd)
	echo l:command_output
endfunction