nu-command 0.75.0

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
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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154

use std::time::Duration;

use nu_protocol::{
    ast::Call,
    engine::{Command, EngineState, Stack},
    Category, Example, IntoInterruptiblePipelineData, PipelineData, ShellError, Signature, Type,
    Value,
};

#[derive(Clone)]
pub struct Ps;

impl Command for Ps {
    fn name(&self) -> &str {
        "ps"
    }

    fn signature(&self) -> Signature {
        Signature::build("ps")
            .input_output_types(vec![(Type::Nothing, Type::Table(vec![]))])
            .switch(
                "long",
                "list all available columns for each entry",
                Some('l'),
            )
            .filter()
            .category(Category::System)
    }

    fn usage(&self) -> &str {
        "View information about system processes."
    }

    fn search_terms(&self) -> Vec<&str> {
        vec!["procedures", "operations", "tasks", "ops"]
    }

    fn run(
        &self,
        engine_state: &EngineState,
        _stack: &mut Stack,
        call: &Call,
        _input: PipelineData,
    ) -> Result<nu_protocol::PipelineData, nu_protocol::ShellError> {
        run_ps(engine_state, call)
    }

    fn examples(&self) -> Vec<Example> {
        vec![
            Example {
                description: "List the system processes",
                example: "ps",
                result: None,
            },
            Example {
                description: "List the top 5 system processes with the highest memory usage",
                example: "ps | sort-by mem | last 5",
                result: None,
            },
            Example {
                description: "List the top 3 system processes with the highest CPU usage",
                example: "ps | sort-by cpu | last 3",
                result: None,
            },
            Example {
                description: "List the system processes with 'nu' in their names",
                example: "ps | where name =~ 'nu'",
                result: None,
            },
        ]
    }
}

fn run_ps(engine_state: &EngineState, call: &Call) -> Result<PipelineData, ShellError> {
    let mut output = vec![];
    let span = call.head;
    let long = call.has_flag("long");

    for proc in nu_system::collect_proc(Duration::from_millis(100), false) {
        let mut cols = vec![];
        let mut vals = vec![];

        cols.push("pid".to_string());
        vals.push(Value::Int {
            val: proc.pid() as i64,
            span,
        });

        cols.push("name".to_string());
        vals.push(Value::String {
            val: proc.name(),
            span,
        });

        #[cfg(not(windows))]
        {
            // Hide status on Windows until we can find a good way to support it
            cols.push("status".to_string());
            vals.push(Value::String {
                val: proc.status(),
                span,
            });
        }

        cols.push("cpu".to_string());
        vals.push(Value::Float {
            val: proc.cpu_usage(),
            span,
        });

        cols.push("mem".to_string());
        vals.push(Value::Filesize {
            val: proc.mem_size() as i64,
            span,
        });

        cols.push("virtual".to_string());
        vals.push(Value::Filesize {
            val: proc.virtual_size() as i64,
            span,
        });

        if long {
            cols.push("command".to_string());
            vals.push(Value::String {
                val: proc.command(),
                span,
            });
            #[cfg(windows)]
            {
                cols.push("cwd".to_string());
                vals.push(Value::String {
                    val: proc.cwd(),
                    span,
                });
                cols.push("environment".to_string());
                vals.push(Value::List {
                    vals: proc
                        .environ()
                        .iter()
                        .map(|x| Value::string(x.to_string(), span))
                        .collect(),
                    span,
                });
            }
        }

        output.push(Value::Record { cols, vals, span });
    }

    Ok(output
        .into_iter()
        .into_pipeline_data(engine_state.ctrlc.clone()))
}