KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #ai-agents #developer-tools #codex #claude-code #mcp #rust #deepseek-harness #typescript #ai-agent #cli

shannon

★ 11 Open GitHub ↗

Nushell + Bash

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Shannon

A poly-shell built on nushell, with seamless bash compatibility. Shift+Tab to
switch between nushell and bash.

Named after [Claude Shannon](https://en.wikipedia.org/wiki/Claude_Shannon), the
father of information theory.

## The Idea

Nushell is powerful but the world runs on bash. Shannon gives you both — press
**Shift+Tab** to switch between nushell and bash. Environment variables and
working directory sync automatically.

```
[nu] ~/project > ls | where size > 1mb
...
[nu] ~/project > <Shift+Tab>

[bash] ~/project > grep -r "TODO" src/ && echo "done"
...
[bash] ~/project > <Shift+Tab>

[nu] ~/project >
```

## Features

### Nushell at the Core

Shannon IS nushell — you get all nushell features out of the box:

- Structured data (tables, records, lists)
- Powerful pipelines (`ls | where size > 1mb | sort-by modified`)
- Job control (Ctrl+Z, `job unfreeze`)
- Native completions, multiline editing, plugins
- Hooks, keybindings, themes — all configurable via `config.nu`

### Bash Compatibility

- **Shift+Tab** to switch to `[bash]` mode for bash commands
- Bash syntax highlighting (tree-sitter-bash, Tokyo Night colors)
- Environment variables sync between nushell and bash automatically
- Standard bash config — `.bash_profile` and `.bashrc` loaded automatically

### Environment Sync

- Environment variables, cwd, and exit code synchronized across mode switches
- Set `export FOO=bar` in bash, switch to nushell — `$env.FOO` works
- Set `$env.BAZ = "qux"` in nushell, switch to bash — `echo $BAZ` works
- PATH and other typed env vars converted automatically via `ENV_CONVERSIONS`

## Configuration

Shannon uses standard config locations — no custom config directory:

| Config  | Location                        | Purpose                                 |
| ------- | ------------------------------- | --------------------------------------- |
| Bash    | `~/.bash_profile` / `~/.bashrc` | PATH, env vars, nvm, homebrew, etc.     |
| Nushell | `~/.config/nushell/env.nu`      | Nushell env setup                       |
| Nushell | `~/.config/nushell/config.nu`   | Keybindings, colors, hooks, completions |

No config files are required — shannon works out of the box. If you already have
nushell and bash configured, shannon uses your existing setup automatically.

## Installation

### Homebrew

With [Homebrew](https://brew.sh) on macOS:

```sh
brew tap shannonshell/shannon
brew trust shannonshell/shannon
brew install shannon
```

Homebrew builds from Shannon's pinned release tarball, and bottled installs are
used when available for your macOS version.

### Cargo

Requires the [Rust toolchain](https://rustup.rs).

```sh
cargo install shannonshell
```

Or install from git (latest development version):

```sh
cargo install --git https://github.com/shannonshell/shannon
```

Or build from source:

```sh
git clone https://github.com/shannonshell/shannon.git
cd shannon
cargo build --release
```

## License

MIT

shannon

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README