Rust命令行工具库nu-cli的使用指南

介绍

nu-cli是一个用Rust编写的命令行工具库，提供了高效的终端交互和脚本解析功能。它源自流行的nushell项目，专注于为开发者提供强大的命令行处理能力。

主要特性：

• 高性能的终端交互
• 强大的脚本解析引擎
• 灵活的管道操作
• 丰富的内置命令
• 易于扩展的插件系统

安装方法

在Cargo.toml中添加依赖：

[dependencies]
nu-cli = "0.60"  # 请使用最新版本

基本使用方法

1. 创建简单的CLI应用

use nu_cli::{create_default_context, run_command};
use nu_parser::parse;
use nu_protocol::engine::StateWorkingSet;

fn main() {
    // 创建执行上下文
    let mut context = create_default_context().unwrap();
    
    // 解析并执行命令
    let input = "echo 'Hello, nu-cli!'";
    let (block, _) = parse(&mut StateWorkingSet::new(&context.engine_state), input, false);
    
    match run_command(&block, &mut context, None) {
        Ok(_) => println!("Command executed successfully"),
        Err(e) => eprintln!("Error: {}", e),
    }
}

2. 处理管道操作

use nu_cli::{create_default_context, run_command};
use nu_parser::parse;
use nu_protocol::engine::StateWorkingSet;

fn main() {
    let mut context = create_default_context().unwrap();
    
    // 管道示例：获取当前目录文件并筛选出.rs文件
    let input = "ls | where name =~ '..rs$'";
    let (block, _) = parse(&mut StateWorkingSet::new(&context.engine_state), input, false);
    
    run_command(&block, &mut context, None).unwrap();
}

3. 自定义命令

use nu_cli::{create_default_context, run_command};
use nu_engine::eval_block;
use nu_parser::parse;
use nu_protocol::{
    engine::{EngineState, StateWorkingSet},
    Signature, Value,
};
use nu_protocol::{Example, PipelineData, ShellError, Span};

// 定义自定义命令
fn hello_command(args: &[Value], _: &EngineState) -> Result<PipelineData, ShellError> {
    let name = if args.is_empty() {
        "World".to_string()
    } else {
        args[0].as_string()?
    };
    
    Ok(PipelineData::Value(Value::String {
        val: format!("Hello, {}!", name),
        span: Span::unknown(),
    }))
}

fn main() {
    let mut context = create_default_context().unwrap();
    
    // 添加自定义命令到引擎状态
    context.engine_state.add_command(
        "hello".to_string(),
        Signature::build("hello").optional("name", "The name to greet"),
        hello_command,
    );
    
    // 使用自定义命令
    let input = "hello \"nu-cli\"";
    let (block, _) = parse(&mut StateWorkingSet::new(&context.engine_state), input, false);
    
    run_command(&block, &mut context, None).unwrap();
}

高级功能

1. 脚本执行

use nu_cli::{create_default_context, run_script};
use std::path::Path;

fn main() {
    let mut context = create_default_context().unwrap();
    
    // 执行脚本文件
    let script_path = Path::new("example.nu");
    match run_script(&mut context, script_path, None) {
        Ok(_) => println!("Script executed successfully"),
        Err(e) => eprintln!("Error: {}", e),
    }
}

2. 交互式终端

use nu_cli::create_default_context;
use nu_cli::run_repl;

fn main() {
    let mut context = create_default_context().unwrap();
    
    // 启动交互式REPL
    if let Err(e) = run_repl(&mut context) {
        eprintln!("REPL error: {}", e);
    }
}

实际应用示例

文件处理管道

use nu_cli::{create_default_context, run_command};
use nu_parser::parse;
use nu_protocol::engine::StateWorkingSet;

fn main() {
    let mut context = create_default_context().unwrap();
    
    // 复杂管道示例：统计当前目录下.rs文件的行数
    let input = r#"
        ls *.rs 
        | each { |file| 
            open $file.name 
            | lines 
            | length 
            | { name: $file.name, lines: $in } 
        }
        | sort-by lines -r
        | first 5
    "#;
    
    let (block, _) = parse(&mut StateWorkingSet::new(&context.engine_state), input, false);
    run_command(&block, &mut context, None).unwrap();
}

完整示例DEMO

下面是一个结合多个功能的完整示例，展示如何创建一个支持自定义命令、管道操作和脚本执行的CLI应用：

use nu_cli::{create_default_context, run_command, run_script};
use nu_engine::eval_block;
use nu_parser::parse;
use nu_protocol::{
    engine::{EngineState, StateWorkingSet},
    Signature, Value,
};
use nu_protocol::{PipelineData, ShellError, Span};
use std::path::Path;

// 自定义命令：计算平方
fn square_command(args: &[Value], _: &EngineState) -> Result<PipelineData, ShellError> {
    let num = if args.is_empty() {
        0
    } else {
        args[0].as_int()?
    };
    
    Ok(PipelineData::Value(Value::Int {
        val: num * num,
        span: Span::unknown(),
    }))
}

fn main() {
    // 创建上下文
    let mut context = create_default_context().unwrap();
    
    // 添加自定义命令
    context.engine_state.add_command(
        "square".to_string(),
        Signature::build("square").required("number", "The number to square"),
        square_command,
    );
    
    // 示例1: 使用自定义命令
    println!("=== 示例1: 使用自定义命令 ===");
    let input1 = "square 5";
    let (block1, _) = parse(&mut StateWorkingSet::new(&context.engine_state), input1, false);
    run_command(&block1, &mut context, None).unwrap();
    
    // 示例2: 管道操作
    println!("\n=== 示例2: 管道操作 ===");
    let input2 = "1..10 | each { |it| square $it } | math sum";
    let (block2, _) = parse(&mut StateWorkingSet::new(&context.engine_state), input2, false);
    run_command(&block2, &mut context, None).unwrap();
    
    // 示例3: 执行脚本文件
    println!("\n=== 示例3: 执行脚本文件 ===");
    let script_path = Path::new("demo.nu");
    if let Err(e) = run_script(&mut context, script_path, None) {
        eprintln!("没有找到脚本文件 demo.nu，跳过此示例");
    }
    
    // 示例4: 启动交互式REPL
    println!("\n=== 示例4: 启动交互式REPL ===");
    println!("输入 exit 退出REPL");
    if let Err(e) = nu_cli::run_repl(&mut context) {
        eprintln!("REPL error: {}", e);
    }
}

注意事项

1. nu-cli仍在积极开发中，API可能会有变动
2. 错误处理应使用Result模式，妥善处理可能的错误
3. 对于性能敏感的应用，建议复用EngineState和Context对象

nu-cli为Rust开发者提供了强大的命令行处理能力，特别适合需要复杂命令行交互或脚本支持的应用程序开发。