nostr-cli 0.43.0

Nostr CLI
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136

// Copyright (c) 2022-2023 Yuki Kishimoto
// Copyright (c) 2023-2025 Rust Nostr Developers
// Distributed under the MIT software license

#![allow(clippy::large_enum_variant)]

use std::path::PathBuf;

use clap::{Parser, Subcommand, ValueEnum};
use nostr_sdk::prelude::*;

pub mod io;
pub mod parser;

#[derive(Debug, Parser)]
#[clap(author, version, about, long_about)]
pub struct Cli {
    #[command(subcommand)]
    pub command: Command,
}

#[derive(Debug, Subcommand)]
pub enum Command {
    /// Open nostr shell
    Shell {
        #[clap(long)]
        relays: Vec<RelayUrl>,
        // tor: bool,
        // proxy: Option<SocketAddr>,
    },
    /// Serve a local relay for test purpose
    Serve {
        /// Port
        #[clap(long)]
        port: Option<u16>,
    },
    /// Serve Nostr Connect signer
    ///
    /// <https://github.com/nostr-protocol/nips/blob/master/46.md>
    Bunker,
}

#[derive(Debug, Parser)]
#[command(name = "")]
pub enum ShellCommand {
    /// Generate random keys
    Generate,
    /// Sync public key's event with specified relays (negentropy)
    #[command(arg_required_else_help = true)]
    Sync {
        /// Public key
        public_key: PublicKey,
        /// Relays
        #[clap(long)]
        relays: Vec<RelayUrl>,
        /// Direction
        #[clap(short, long, value_enum, default_value_t = ShellSyncDirection::Down)]
        direction: ShellSyncDirection,
    },
    /// Query
    Query {
        /// Event ID
        #[clap(long)]
        id: Option<EventId>,
        /// Author
        #[clap(short, long)]
        author: Option<PublicKey>,
        /// Kind
        #[clap(short, long)]
        kind: Option<Kind>,
        /// Identifier (`d` tag)
        #[clap(long)]
        identifier: Option<String>,
        /// Full-text search
        #[clap(long)]
        search: Option<String>,
        /// Since
        #[clap(short, long)]
        since: Option<Timestamp>,
        /// Until
        #[clap(short, long)]
        until: Option<Timestamp>,
        /// Limit
        #[clap(short, long)]
        limit: Option<usize>,
        /// Query only database
        #[clap(long)]
        database: bool,
        /// Print result
        #[clap(long)]
        print: bool,
        /// Print result as JSON (require `print` flag!)
        #[clap(long)]
        json: bool,
    },
    /// Database
    #[command(arg_required_else_help = true)]
    Database {
        #[command(subcommand)]
        command: ShellCommandDatabase,
    },
    /// Exit
    Exit,
}

#[derive(Debug, Subcommand)]
pub enum ShellCommandDatabase {
    /// Populate database
    #[command(arg_required_else_help = true)]
    Populate {
        /// Path of JSON file
        path: PathBuf,
    },
    /// Database stats
    Stats,
}

#[derive(Debug, Clone, ValueEnum)]
pub enum ShellSyncDirection {
    /// Send events to relay
    Up,
    /// Get events from relay
    Down,
    /// Both send and get events from relay (bidirectional sync)
    Both,
}

impl From<ShellSyncDirection> for SyncDirection {
    fn from(value: ShellSyncDirection) -> Self {
        match value {
            ShellSyncDirection::Up => Self::Up,
            ShellSyncDirection::Down => Self::Down,
            ShellSyncDirection::Both => Self::Both,
        }
    }
}