https://github.com/jiftechnify/vscode-nostr-client

A Nostr client in VSCode!
https://github.com/jiftechnify/vscode-nostr-client

nostr vscode-extension

Last synced: 6 months ago
JSON representation

A Nostr client in VSCode!

• Host: GitHub
• URL: https://github.com/jiftechnify/vscode-nostr-client
• Owner: jiftechnify
• License: mit
• Created: 2023-08-24T15:37:13.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-05-06T05:05:07.000Z (about 2 years ago)
• Last Synced: 2024-05-07T05:27:15.013Z (about 2 years ago)
• Topics: nostr, vscode-extension
• Language: TypeScript
• Homepage: https://marketplace.visualstudio.com/items?itemName=jiftechnify.nostr-client
• Size: 531 KB
• Stars: 6
• Watchers: 1
• Forks: 0
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# vscode-nostr-client

A Nostr client in VSCode!

## Features

- Posting text notes

- Updating user status ([NIP-38](https://github.com/nostr-protocol/nips/blob/master/38.md))

## Usage

### 🔑 Prerequisite: Setting Private Key

First, set your Nostr private key. Open the command palette then run `Nostr: Set Private Key`. Hex key and `nsec` are supported!

### 📝 Posting Text Notes

Just run `Nostr: Post Text` command!

### 👨‍💻 Updating User Status

Run `Nostr: Update Status`, input your current status, and select the time to expiration. That's it!

With `Nostr: Update Status with Link`, you can also update your status with a link.

### 🧭 Setting Bootstrap Relays and Sync-ing Account Metadata

If posting notes doesn't seem to work, you may want to setup "bootstrap relays", from which your account metadata (e.g. relays to write) are fetched.

1. Open user settings.

2. Type "nostr" in the search box and find out the configuration item `Nostr Client: Bootstrap Relays`.

3. Click [Add item] and input relay URLs you are using.

![bootstrap relays config](./assets/vsc-nostr-bootstrap-relays-config.png)

Don't forget to run `Nostr: Synchronize Account Metadata` to update metadata after setting bootstrap relays!

## Notes

- This extension uses `vscode.SecretStorage` to store your private key. It is encrypted and finally stored in OS keyring. However, **it is not guaranteed that stored key won't be peeked by other (malicious) extension**. Please keep in mind that, and use this extension at your own risk.

## Credits

- The extension icon is based on [this awesome work](https://github.com/mbarulli/nostr-logo/) by [Andrea Nicolini](https://dribbble.com/Bembureda).