nu-command 0.112.2

Nushell's built-in commands
Documentation 
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

use nu_engine::{command_prelude::*, env_to_strings};

#[derive(Clone)]
pub struct DebugEnv;

impl Command for DebugEnv {
    fn name(&self) -> &str {
        "debug env"
    }

    fn signature(&self) -> Signature {
        Signature::build(self.name())
            .input_output_type(Type::Nothing, Type::record())
            .category(Category::Debug)
    }

    fn description(&self) -> &str {
        "Show environment variables as external commands would get it."
    }

    fn run(
        &self,
        engine_state: &EngineState,
        stack: &mut Stack,
        call: &Call,
        _input: PipelineData,
    ) -> Result<PipelineData, ShellError> {
        Ok(PipelineData::value(
            env_to_strings(engine_state, stack)?.into_value(call.head),
            None,
        ))
    }

    fn examples(&self) -> Vec<Example<'_>> {
        vec![
            Example {
                description: "Get PATH variable that externals see.",
                example: "debug env | get PATH!",
                result: None,
            },
            Example {
                description: "Create a .env file.",
                example: r#"debug env | transpose key value | each {$"($in.key)=($in.value | to json)"} | save .env"#,
                result: None,
            },
        ]
    }
}