shell-cell 1.2.0

Shell-Cell. CLI app to spawn and manage containerized shell environments
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

<div align="center">

<img src="./logo.png" alt="logo" />

# **Shell-Cell**

Lightweight CLI tool that turns simple YAML blueprints into instant, isolated, and reproducible containerized development shell sessions.

> ⚠️ Under heavy development, backwards compatibility is not guaranteed, and future versions may introduce breaking changes.

</div>

## 💡 How It Works

**Shell-Cell** reads a `scell.yml` blueprint, compiles it into a image, and launches a persistent container that acts as a "shell server". You can then attach interactive shell sessions to this warm, ready-to-use environment.

## 🚀 Quick Start

### Prerequisites

A running [Docker](https://www.docker.com/) (or [Podman](https://podman.io/)) daemon is required.

### Install

- Build for Unix 
<!-- cspell: disable -->
```shell
curl -fsSL https://github.com/Mr-Leshiy/shell-cell/releases/latest/download/shell-cell-installer.sh | sh
```
<!-- cspell: enable -->

- Build from source (any platform)
```shell
cargo install shell-cell --locked
```

For socket configuration and other setup details, see the [Install and Configure](https://mr-leshiy.github.io/shell-cell/install) guide.

### Create a Blueprint

Place a `scell.yml` file in your project directory (see the full [Blueprint Reference](https://mr-leshiy.github.io/shell-cell/blueprint) for all available instructions):

```yml
main:
  from_image: debian:bookworm
  workspace: /app
  shell: /bin/bash
  hang: while true; do sleep 3600; done
```

### Launch a Session

```shell
scell
```

That's it! **Shell-Cell** will find the `scell.yml` in your current directory, build the environment, and drop you into an interactive shell. For more CLI options and usage patterns, see the [CLI Reference](https://mr-leshiy.github.io/shell-cell/cli).

## 👨🏻‍👩🏻‍👦🏻‍👦🏻 Community

Our Discord server <https://discord.gg/URTBEuU5>

## 🎓 Want to know more ?

Follow the detailed documentation about how **Shell-Cell** works and how to use it:

👉 [Docs](https://mr-leshiy.github.io/shell-cell/)


## ➡️ Whats next?

Want to see what we’re working on? Check out our journey here:

👉 [Roadmap](./roadmap.md)

## ❤️ Contributing & Feedback

If you run into a bug or have a "what if" idea, don't be a stranger — open an issue, start a discussion or make a pull-request!