nu_plugin_template/README.md.liquid at main · nushell/nu_plugin_template · GitHub

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
# {{ project-name }}

This is a [Nushell](https://nushell.sh/) plugin called "{{ plugin_name }}".

## Installing

```nushell
> cargo install --path .
```

## Usage

FIXME: This reflects the demo functionality generated with the template. Update this documentation
once you have implemented the actual plugin functionality.

```nushell
> plugin add ~/.cargo/bin/{{ project-name }}
> plugin use {{ plugin_name }}
{% if command_is_simple -%}
> {{ command_name }} Ellie
Hello, Ellie. How are you today?
> {{ command_name }} --shout Ellie
HELLO, ELLIE. HOW ARE YOU TODAY?
{%- else -%}
> [ Ellie ] | {{ command_name }}
╭───┬──────────────────────────────────╮
│ 0 │ Hello, Ellie. How are you today? │
╰───┴──────────────────────────────────╯
> [ Ellie ] | {{ command_name }} --shout
╭───┬──────────────────────────────────╮
│ 0 │ HELLO, ELLIE. HOW ARE YOU TODAY? │
╰───┴──────────────────────────────────╯
{%- endif %}
```