https://github.com/fiatjaf/noscl

Command line client for Nostr.
https://github.com/fiatjaf/noscl

nostr

Last synced: 24 days ago
JSON representation

Command line client for Nostr.

• Host: GitHub
• URL: https://github.com/fiatjaf/noscl
• Owner: fiatjaf
• License: other
• Archived: true
• Created: 2021-01-11T00:52:04.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2024-01-27T11:09:08.000Z (11 months ago)
• Last Synced: 2024-08-04T11:01:16.956Z (4 months ago)
• Topics: nostr
• Language: Go
• Homepage:
• Size: 66.4 KB
• Stars: 270
• Watchers: 11
• Forks: 53
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-nostr - noscl - a basic command-line client written in Go (Clients / Relay lists)

README

        
noscl

=====

[![Go Report Card](https://goreportcard.com/badge/github.com/fiatjaf/noscl)](https://goreportcard.com/report/github.com/fiatjaf/noscl)  [![License: ODbL](https://img.shields.io/badge/License-PDDL-brightgreen.svg)](https://opendatacommons.org/licenses/pddl/)  [![Latest Release](https://img.shields.io/github/v/release/fiatjaf/noscl?logo=github)](https://github.com/fiatjaf/noscl/releases)

Command line client for [Nostr](https://github.com/fiatjaf/nostr).

## Notice

Although it works, this project is somewhat abandoned. For a more complete CLI experience you can try https://github.com/mattn/algia and for a more streamlined CLI plumbing tool try https://github.com/fiatjaf/nak.

## Installation

Compile with `go install github.com/fiatjaf/noscl@latest` or [download a binary](https://github.com/fiatjaf/noscl/releases).

## Usage

```

noscl

Usage:

  noscl home

  noscl setprivate 

  noscl public

  noscl publish [--reference=...] [--profile=...] 

  noscl message [--reference=...]  

  noscl metadata --name= [--about=] [--picture=]

  noscl profile 

  noscl follow  [--name=]

  noscl unfollow 

  noscl following

  noscl event 

  noscl share-contacts

  noscl key-gen

  noscl relay

  noscl relay add 

  noscl relay remove 

  noscl relay recommend 

```

The basic flow is something like

1. Add some relays with `noscl relay add ` (see https://nostr.watch/relays/find for some publicly available relays)

2. Follow some people with `noscl follow `

3. Browse some profiles from people (you don't have to be following) with `noscl profile `

4. See the feed of people you follow with `noscl home`

5. Set your own private key with `noscl setprivate `

6. Get your public key with `noscl public` so you can share it with others

7. Publish some notes with `noscl publish `

## Generate a key

```

$ noscl key-gen

seed: crowd coconut donate calm position chuckle update friend ball gospel sudden answer bitter dinosaur wise express jaguar file praise pact defy system struggle offer

private key: 5a860fa953c9162611f2e2813ee0526370664534412f31611a4a89149c6bbc9d

$ noscl setprivate 5a860fa953c9162611f2e2813ee0526370664534412f31611a4a89149c6bbc9d

```

## Sign an event manually

```

noscl sign '{...event as JSON}'

```

https://user-images.githubusercontent.com/1653275/149637925-32943e2e-a2ff-41a0-9e3d-5ea1a60c84ae.mp4