Skip to content

Commit f41507e

Browse files
committed
add a readme
1 parent 462e612 commit f41507e

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# nushell/plugin-examples
2+
[![Nushell](https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2Fnushell%2Fplugin-examples%2Frefs%2Fheads%2Fsetup%2FCargo.toml&query=workspace.dependencies.nu-protocol.version&prefix=v&label=nushell&color=%234E9906)](https://github.com/nushell/nushell)
3+
[![Build Status](https://img.shields.io/github/actions/workflow/status/nushell/plugin-examples/ci.yml)](https://github.com/nushell/plugin-examples/actions)
4+
5+
Plugin examples for Nushell in different languages.
6+
7+
## About
8+
This repo has example Nushell plugins written in different languages.
9+
Each plugin is tested daily via CI against the latest `main` branch of
10+
[nushell](https://github.com/nushell/nushell).
11+
You can use them as a starting point for building your own plugin.
12+
13+
For more real plugins, check out
14+
[nushell/awesome-nu](https://github.com/nushell/awesome-nu?tab=readme-ov-file#plugins).
15+
16+
## Plugins
17+
Plugins are organized by language (e.g. `rust/`) and live in their own folders.
18+
Each folder usually includes:
19+
- a test file
20+
- a `.cmd` file if the plugin needs a scripting runtime (helps with local testing on Windows)
21+
22+
Every plugin is also listed in the [CI workflow](./.github/workflows/ci.yml) to
23+
ensure it gets tested regularly.

0 commit comments

Comments
 (0)