pagedmov/shed
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
pagedmov
2026-02-27 09:59:12 -05:00
parent 3d3693e2c3
commit ea8539c929
1 changed files with 13 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@@ -1,6 +1,6 @@
# shed # shed
A Linux shell written in Rust. The name is a nod to both `sh` and `ed`. It's a shell with a heavy emphasis on smooth line editing. A Linux shell written in Rust. The name is a nod to the original Unix utilities `sh` and `ed`. It's a shell with a heavy emphasis on smooth line editing.
<img width="506" height="407" alt="shed" src="https://github.com/user-attachments/assets/5333dd47-ae1b-45cd-8729-b623f586b10e" /> <img width="506" height="407" alt="shed" src="https://github.com/user-attachments/assets/5333dd47-ae1b-45cd-8729-b623f586b10e" />
@@ -66,10 +66,6 @@ shed's scripting language contains all of the essentials.
- `fg`, `bg`, `jobs`, `disown` with flags (`-l`, `-p`, `-r`, `-s`, `-h`, `-a`) - `fg`, `bg`, `jobs`, `disown` with flags (`-l`, `-p`, `-r`, `-s`, `-h`, `-a`)
- Process group management and proper signal forwarding - Process group management and proper signal forwarding
### Builtins
`echo`, `cd`, `pwd`, `read`, `export`, `local`, `readonly`, `unset`, `source`, `eval`, `exec`, `shift`, `alias`, `unalias`, `trap`, `jobs`, `fg`, `bg`, `disown`, `pushd`, `popd`, `dirs`, `shopt`, `builtin`, `command`, `return`, `break`, `continue`, `exit`, `true`, `false`, `:`
### Configuration ### Configuration
Shell options are managed through `shopt`: Shell options are managed through `shopt`:
@@ -91,6 +87,7 @@ The rc file is loaded from `~/.shedrc` on startup.
Requires Rust (edition 2024). Requires Rust (edition 2024).
```sh ```sh
git clone https://github.com/km-clay/shed.git
cargo build --release cargo build --release
``` ```
@@ -98,7 +95,7 @@ The binary will be at `target/release/shed`.
### Nix ### Nix
A flake is provided with a NixOS module and a Home Manager module. A flake is provided with a NixOS module, a Home Manager module, and a simple overlay that adds `pkgs.shed`.
```sh ```sh
# Build and run directly # Build and run directly
@@ -126,6 +123,16 @@ Or with Home Manager:
imports = [ shed.homeModules.shed ]; imports = [ shed.homeModules.shed ];
``` ```
And the overlay:
```nix
pkgs = import nixpkgs {
overlays = [
shed.overlays.default
];
};
```
## Status ## Status
`shed` is experimental software and is currently under active development. It covers most day-to-day interactive shell usage and a good portion of POSIX shell scripting, but it is not yet fully POSIX-compliant. There is no guarantee that your computer will not explode when you run this. Use it at your own risk, the software is provided as-is. `shed` is experimental software and is currently under active development. It covers most day-to-day interactive shell usage and a good portion of POSIX shell scripting, but it is not yet fully POSIX-compliant. There is no guarantee that your computer will not explode when you run this. Use it at your own risk, the software is provided as-is.