aopt-shell 0.3.1

A flexible and typed getopt tools
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

# aopt-shell


Shell completion support for aopt framework.

## Example


```rust
use std::ffi::OsString;
use std::path::PathBuf;

use cote::prelude::*;
use cote::shell::get_complete_cli;
use cote::shell::shell::Complete;
use cote::shell::value::once_values;
use cote::shell::CompletionManager;

#[derive(Debug, Cote)]

pub struct Cli {
    /// Print debug message
    debug: bool,

    /// Set the count value of cli
    count: Option<i64>,

    /// Set the files of cli
    #[arg(alias = "-f")]
    files: Vec<PathBuf>,
}

fn main() -> color_eyre::Result<()> {
    color_eyre::install()?;

    match get_complete_cli() {
        Ok(cli) => {
            if cli.write_stdout("fput", "fput").is_err() {
                cli.complete(|shell| {
                    let mut ctx = cli.get_context()?;
                    let mut completion = CompletionManager::new(Cli::into_parser()?);

                    shell.set_buff(std::io::stdout());
                    completion.set_values(completion.optset().find_uid("--count")?, ["42", "56"]);
                    completion.set_values(
                        completion.optset().find_uid("--files")?,
                        once_values(|_| {
                            Ok(["files/a.txt", "files/b.txt", "files/c.txt"]
                                .map(OsString::from)
                                .into_iter()
                                .collect())
                        }),
                    );
                    completion.complete(shell, &mut ctx)?;
                    Ok(())
                })?;
            }
        }
        Err(_) => {
            let cli = Cli::parse_env()?;

            println!("doing normal cli things..: {cli:?}");
        }
    }

    Ok(())
}
```

## Deploy shell completions


PROGRAM is the name of binary

### bash


```bash
echo 'source <(PROGRAM --_shell bash)' >> ~/.bashrc
```

### fish


```fish
echo 'PROGRAM --_shell fish | source' >> ~/.config/fish/config.fish
```

### Zsh


```zsh
echo 'source <(PROGRAM --_shell zsh)' >> ~/.zshrc
```

### Powershell


```powershell
Add-Content $PROFILE "`nPROGRAM --_shell powershell | Out-String | Invoke-Expression"
```

## More 


- simple-find-file

A simple file search tools, try it using [`cargo install --path simple-find-file`](https://github.com/araraloren/aopt/tree/main/simple-find-file).

- snowball-follow

Get the follow count of stock in `xueqiu.com`, try it using [`cargo install --path snowball-follow`](https://github.com/araraloren/aopt/tree/main/snowball-follow)

## LICENSE


MPL-2.0