Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mattn/algia
A cli application for nostr
https://github.com/mattn/algia
nostr
Last synced: about 1 month ago
JSON representation
A cli application for nostr
- Host: GitHub
- URL: https://github.com/mattn/algia
- Owner: mattn
- License: mit
- Created: 2023-02-15T00:25:51.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-02T16:35:27.000Z (5 months ago)
- Last Synced: 2024-05-03T07:11:37.432Z (5 months ago)
- Topics: nostr
- Language: Go
- Homepage:
- Size: 208 KB
- Stars: 144
- Watchers: 6
- Forks: 21
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-nostr-japan - algia - nostr向けcliアプリケーション by [mattn](https://github.com/mattn) (CLI Clients)
- awesome-nostr - algia - A cli application for nostr. (Clients / Relay lists)
README
# algia
nostr CLI client written in Go
## Usage
```
NAME:
algia - A cli application for nostr
USAGE:
algia [global options] command [command options]
DESCRIPTION:
A cli application for nostr
COMMANDS:
timeline, tl show timeline
stream show stream
post, n post new note
reply, r reply to the note
repost, b repost the note
unrepost, B unrepost the note
like, l like the note
unlike, L unlike the note
delete, d delete the note
search, s search notes
dm-list show DM list
dm-timeline show DM timeline
dm-post post new note
profile show profile
powa post ぽわ〜
puru post ぷる
zap zap [note|npub|nevent]
version show version
help, h Shows a list of commands or help for one command
GLOBAL OPTIONS:
-a value profile name
--relays value relays
-V verbose (default: false)
--help, -h show help
```
## Installation
Download binary from Release page.
Or install with go install command.
```
go install github.com/mattn/algia@latest
```
## Configuration
Minimal configuration. Need to be at ~/.config/algia/config.json
```json
{
"relays": {
"wss://relay-jp.nostr.wirednet.jp": {
"read": true,
"write": true,
"search": false
}
},
"privatekey": "nsecXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
}
```
If you want to zap via Nostr Wallet Connect, please add `nwc-pub` and `nwc-uri` which are provided from
```json
{
"relays": {
...
},
"privatekey": "nsecXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"nwc-uri": "nostr+walletconnect://xxxxx",
"nwc-pub": "xxxxxxxxxxxxxxxxxxxxxxx"
}
```
## TODO
* [x] like
* [x] repost
* [x] zap
* [x] upload images
## FAQ
Do you use proxy? then set environment variable `HTTP_PROXY` like below.
HTTP_PROXY=http://myproxy.example.com:8080
## License
MIT
## Author
Yasuhiro Matsumoto (a.k.a. mattn)