nu-command 0.115.1

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

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

#[derive(Clone)]
pub struct Idx;

impl Command for Idx {
    fn name(&self) -> &str {
        "idx"
    }

    fn signature(&self) -> Signature {
        Signature::build("idx")
            .input_output_types(vec![(Type::Nothing, Type::String)])
            .category(Category::FileSystem)
    }

    fn description(&self) -> &str {
        "Manage in-memory file index state."
    }

    fn extra_description(&self) -> &str {
        "Use one of the subcommands: init, status, find, search, watch, drop, dirs, files. \
By default `idx init` enables filesystem watching so the index updates as files change; pass `--no-watch` for a static index. \
Use `idx watch` to stream change events from that live index into a pipeline."
    }

    fn run(
        &self,
        engine_state: &EngineState,
        stack: &mut Stack,
        call: &Call,
        _input: PipelineData,
    ) -> Result<PipelineData, ShellError> {
        Ok(Value::string(
            get_full_help(self, engine_state, stack, call.head),
            call.head,
        )
        .into_pipeline_data())
    }
}