https://github.com/kindlyfire/nci
Publish and query content indexes on nostr
https://github.com/kindlyfire/nci
ipfs nostr torrent
Last synced: about 1 month ago
JSON representation
Publish and query content indexes on nostr
- Host: GitHub
- URL: https://github.com/kindlyfire/nci
- Owner: kindlyfire
- License: mit
- Created: 2025-07-16T16:11:34.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-07-19T08:28:27.000Z (11 months ago)
- Last Synced: 2025-07-19T13:25:27.179Z (11 months ago)
- Topics: ipfs, nostr, torrent
- Language: TypeScript
- Homepage:
- Size: 25.4 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# nci
`nci` is a program to search and publish content indexes (lists of URLs, IPFS
CIDs, magnet links, ...) hosted on the Nostr network.
Spec: [SPECIFICATION.md](SPECIFICATION.md)
## Installation
```bash
npx @kindlyfire/nci --help
# Or install it globally
npm install -g @kindlyfire/nci
nci --help
# Usage: nci [options] [command]
#
# CLI for managing content indexes on nostr
#
# Commands:
# search [options] [query] Search content indexes
# publish [options] Publish an index file to nostr
# delete [options] Delete all NCI events associated with a private key
# list-indexes [options] List all content indexes
# key [privkey] Generate or display Nostr keys
# help [command] display help for command
```
## Usage
Publish an index:
```bash
$ npx @kindlyfire/nci publish example-index.yaml --privkey
📄 Loading index file: example-index.yaml
Primary Key: programming-tutorials
Title: Programming Tutorials (dummy data)
Summary: Collection of programming tutorials and courses (dummy data)
URL: https://github.com/example/programming-tutorials
Items: 5
--- Event 1/2
✅ All relays succeeded
--- Event 2/2
✅ All relays succeeded
URI: nci:?k=programming-tutorials
```
Query an index:
```bash
$ npx @kindlyfire/nci search 'nci:?k=programming-tutorials' type
Found 1 matching item(s) in "Programming Tutorials (dummy data)":
1. TypeScript Fundamentals (1/15/2024)
Complete guide to TypeScript from basics to advanced features
typescript, javascript, programming
https://example.com/typescript-fundamentals.mp4, ipfs://QmTypeScriptHash123456
```
List indexes. Without any kind of filters, this will list all indexes found on Nostr:
```bash
$ npx @kindlyfire/nci list-indexes
📋 Listing content indexes...
Found 1 index(es):
1. Programming Tutorials
Collection of programming tutorials and courses
URL: https://github.com/example/programming-tutorials
URI: nci:null?k=programming-tutorials
Items: 0
```
## Future Ideas
Potential ideas for future related work, not necessarily in this project:
- An MCP server
- A web interface
- This can be an SPA published on IPFS
- Add JSON output option for the CLI commands