Skip to content

Rust library for managing an interactive command-line session

Notifications You must be signed in to change notification settings

jacklund/repl-rs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

69 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

repl-rs

Library to help you create a REPL for your application.

Basic example code:

use std::collections::HashMap;
use repl_rs::{Command, Error, Parameter, Result, Value};
use repl_rs::{Convert, Repl};

// Add two numbers.
fn add<T>(args: HashMap<String, Value>, _context: &mut T) -> Result<Option<String>> {
   let first: i32 = args["first"].convert()?;
   let second: i32 = args["second"].convert()?;

   Ok(Some((first + second).to_string()))
}

// Write "Hello"
fn hello<T>(args: HashMap<String, Value>, _context: &mut T) -> Result<Option<String>> {
   Ok(Some(format!("Hello, {}", args["who"])))
}

fn main() -> Result<()> {
   let mut repl = Repl::new(())
       .with_name("MyApp")
       .with_version("v0.1.0")
       .with_description("My very cool app")
       .add_command(
           Command::new("add", add)
               .with_parameter(Parameter::new("first").set_required(true)?)?
               .with_parameter(Parameter::new("second").set_required(true)?)?
               .with_help("Add two numbers together"),
       )
       .add_command(
            Command::new("hello", hello)
                .with_parameter(Parameter::new("who").set_required(true)?)?
                .with_help("Greetings!"),
   );
   repl.run()
}

Running the example above:

% my_app
Welcome to MyApp v0.1.0
MyApp> help
MyApp v0.1.0: My very cool app
------------------------------                              
add - Add two numbers together
hello - Greetings!
MyApp> help add
add: Add two numbers together
Usage:
        add first second
MyApp> add 1 2
3
MyApp> 

About

Rust library for managing an interactive command-line session

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages