cli: rename open command to shell

Signed-off-by: Yuki Kishimoto <[email protected]>

Author: yukibtc

CHANGELOG.md

@@ -78,6 +78,7 @@
 * sdk: inherit pool subscriptions only when calling `Client::add_relay` or `Client::add_read_relay` methods ([Yuki Kishimoto])
 * ffi(nostr): impl `Display` for `Coordinate` ([Yuki Kishimoto])
 * ffi(sdk): change `Connection::embedded_tor` fingerprint for `android` and `ios` targets ([Yuki Kishimoto])
+* cli: rename `open` command to `shell` ([Yuki Kishimoto])
 
 ### Added
 

crates/nostr-cli/src/cli/mod.rs

@@ -16,12 +16,13 @@ pub mod parser;
 #[clap(author, version, about, long_about)]
 pub struct Cli {
     #[command(subcommand)]
-    pub command: CliCommand,
+    pub command: Command,
 }
 
 #[derive(Debug, Subcommand)]
-pub enum CliCommand {
-    Open {
+pub enum Command {
+    /// Open nostr shell
+    Shell {
         #[clap(long)]
         relays: Vec<Url>,
         // tor: bool,
@@ -37,7 +38,7 @@ pub enum CliCommand {
 
 #[derive(Debug, Parser)]
 #[command(name = "")]
-pub enum Command {
+pub enum ShellCommand {
     /// Generate random keys
     Generate,
     /// Sync public key's event with specified relays (negentropy)
@@ -49,8 +50,8 @@ pub enum Command {
         #[clap(long)]
         relays: Vec<Url>,
         /// Direction
-        #[clap(short, long, value_enum, default_value_t = CliNegentropyDirection::Down)]
-        direction: CliNegentropyDirection,
+        #[clap(short, long, value_enum, default_value_t = ShellNegentropyDirection::Down)]
+        direction: ShellNegentropyDirection,
     },
     /// Query
     Query {
@@ -92,16 +93,14 @@ pub enum Command {
     #[command(arg_required_else_help = true)]
     Database {
         #[command(subcommand)]
-        command: DatabaseCommand,
+        command: ShellCommandDatabase,
     },
-    /// Developer tools
-    Dev {},
     /// Exit
     Exit,
 }
 
 #[derive(Debug, Subcommand)]
-pub enum DatabaseCommand {
+pub enum ShellCommandDatabase {
     /// Populate database
     #[command(arg_required_else_help = true)]
     Populate {
@@ -112,11 +111,8 @@ pub enum DatabaseCommand {
     Stats,
 }
 
-#[derive(Debug, Subcommand)]
-pub enum DevCommands {}
-
 #[derive(Debug, Clone, ValueEnum)]
-pub enum CliNegentropyDirection {
+pub enum ShellNegentropyDirection {
     /// Send events to relay
     Up,
     /// Get events from relay
@@ -125,12 +121,12 @@ pub enum CliNegentropyDirection {
     Both,
 }
 
-impl From<CliNegentropyDirection> for NegentropyDirection {
-    fn from(value: CliNegentropyDirection) -> Self {
+impl From<ShellNegentropyDirection> for NegentropyDirection {
+    fn from(value: ShellNegentropyDirection) -> Self {
         match value {
-            CliNegentropyDirection::Up => Self::Up,
-            CliNegentropyDirection::Down => Self::Down,
-            CliNegentropyDirection::Both => Self::Both,
+            ShellNegentropyDirection::Up => Self::Up,
+            ShellNegentropyDirection::Down => Self::Down,
+            ShellNegentropyDirection::Both => Self::Both,
         }
     }
 }

crates/nostr-cli/src/main.rs

@@ -16,7 +16,7 @@ use tokio::time::Instant;
 mod cli;
 mod util;
 
-use self::cli::{io, parser, Cli, CliCommand, Command, DatabaseCommand};
+use self::cli::{io, parser, Cli, Command, ShellCommand, ShellCommandDatabase};
 
 #[tokio::main]
 async fn main() {
@@ -29,7 +29,7 @@ async fn run() -> Result<()> {
     let args = Cli::parse();
 
     match args.command {
-        CliCommand::Open { relays } => {
+        Command::Shell { relays } => {
             let db = NostrLMDB::open("./db/nostr-lmdb")?;
             let client = Client::builder().database(db).build();
 
@@ -49,7 +49,7 @@ async fn run() -> Result<()> {
                         rl.add_history_entry(line.as_str())?;
                         let mut vec: Vec<String> = parser::split(&line)?;
                         vec.insert(0, String::new());
-                        match Command::try_parse_from(vec) {
+                        match ShellCommand::try_parse_from(vec) {
                             Ok(command) => {
                                 if let Err(e) = handle_command(command, &client).await {
                                     eprintln!("Error: {e}");
@@ -75,7 +75,7 @@ async fn run() -> Result<()> {
 
             Ok(())
         }
-        CliCommand::Serve => {
+        Command::Serve => {
             let mock = MockRelay::run().await?;
 
             println!("Relay running at {}", mock.url());
@@ -115,15 +115,15 @@ async fn run() -> Result<()> {
     }
 }
 
-async fn handle_command(command: Command, client: &Client) -> Result<()> {
+async fn handle_command(command: ShellCommand, client: &Client) -> Result<()> {
     match command {
-        Command::Generate => {
+        ShellCommand::Generate => {
             let keys: Keys = Keys::generate();
             println!("Secret key: {}", keys.secret_key().to_bech32()?);
             println!("Public key: {}", keys.public_key().to_bech32()?);
             Ok(())
         }
-        Command::Sync {
+        ShellCommand::Sync {
             public_key,
             relays,
             direction,
@@ -179,7 +179,7 @@ async fn handle_command(command: Command, client: &Client) -> Result<()> {
 
             Ok(())
         }
-        Command::Query {
+        ShellCommand::Query {
             id,
             author,
             kind,
@@ -255,8 +255,8 @@ async fn handle_command(command: Command, client: &Client) -> Result<()> {
 
             Ok(())
         }
-        Command::Database { command } => match command {
-            DatabaseCommand::Populate { path } => {
+        ShellCommand::Database { command } => match command {
+            ShellCommandDatabase::Populate { path } => {
                 if path.exists() && path.is_file() {
                     // Open JSON file
                     let file = File::open(path)?;
@@ -299,13 +299,12 @@ async fn handle_command(command: Command, client: &Client) -> Result<()> {
 
                 Ok(())
             }
-            DatabaseCommand::Stats => {
+            ShellCommandDatabase::Stats => {
                 println!("TODO");
                 Ok(())
             }
         },
-        Command::Dev {} => Ok(()),
-        Command::Exit => std::process::exit(0x01),
+        ShellCommand::Exit => std::process::exit(0x01),
     }
 }