Skip to content

Commit b41246c

Browse files
eminwuxeminwux
authored
Merge pull request #102 from eminwux/dev
release: prep 0.6.0
2 parents 8ce871b + f9dbffa commit b41246c

File tree

12 files changed

+91
-87
lines changed

12 files changed

+91
-87
lines changed

‎README.md‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ export OS=linux # Options: linux, darwin, freebsd
2222
export ARCH=amd64 # Options: amd64, arm64
2323

2424
# Install sbsh
25-
curl -L -o sbsh https://github.com/eminwux/sbsh/releases/download/v0.5.0/sbsh-${OS}-${ARCH} && \
25+
curl -L -o sbsh https://github.com/eminwux/sbsh/releases/download/v0.6.0/sbsh-${OS}-${ARCH} && \
2626
chmod +x sbsh && \
2727
sudo install -m 0755 sbsh /usr/local/bin/sbsh && \
2828
sudo ln -f /usr/local/bin/sbsh /usr/local/bin/sb
@@ -37,6 +37,10 @@ source <(sb autocomplete bash)
3737
EOF
3838
```
3939

40+
## Documentation
41+
42+
Complete documentation is available at [https://sbsh.io](https://sbsh.io), including guides, tutorials, API reference, and examples.
43+
4044
## Why sbsh
4145

4246
_Terminal-as-Code_ brings the discipline of Infrastructure-as-Code to interactive environments:
@@ -237,10 +241,10 @@ Key benefits: reproducibility (same profile locally and in CI), debugging (persi
237241
Official Docker images for running persistent terminals in containerized environments. Quick deployment in Docker, Kubernetes, or any container orchestration platform.
238242
239243
```bash
240-
docker pull docker.io/eminwux/sbsh:v0.5.0-linux-amd64
244+
docker pull docker.io/eminwux/sbsh:v0.6.0-linux-amd64
241245
docker run -it --rm \
242246
-v ~/.sbsh:/root/.sbsh \
243-
docker.io/eminwux/sbsh:v0.5.0-linux-amd64 \
247+
docker.io/eminwux/sbsh:v0.6.0-linux-amd64 \
244248
sbsh
245249
```
246250

‎docs/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -400,7 +400,7 @@ export OS=linux # Options: linux, darwin, freebsd, android(arm64 only)
400400
export ARCH=amd64 # Options: amd64, arm64
401401

402402
# Install sbsh
403-
curl -L -o sbsh https://github.com/eminwux/sbsh/releases/download/v0.5.0/sbsh-${OS}-${ARCH} && \
403+
curl -L -o sbsh https://github.com/eminwux/sbsh/releases/download/v0.6.0/sbsh-${OS}-${ARCH} && \
404404
chmod +x sbsh && \
405405
sudo install -m 0755 sbsh /usr/local/bin/sbsh && \
406406
sudo ln -f /usr/local/bin/sbsh /usr/local/bin/sb

‎docs/cicd.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Install sbsh in your GitHub Actions workflow:
5151
```yaml
5252
- name: Setup sbsh
5353
run: |
54-
wget -O sbsh https://github.com/eminwux/sbsh/releases/download/v0.5.0/sbsh-linux-amd64
54+
wget -O sbsh https://github.com/eminwux/sbsh/releases/download/v0.6.0/sbsh-linux-amd64
5555
chmod +x sbsh && sudo install -m 0755 sbsh /usr/local/bin/sbsh
5656
sudo ln -f /usr/local/bin/sbsh /usr/local/bin/sb
5757
```
@@ -71,7 +71,7 @@ jobs:
7171

7272
- name: Setup sbsh
7373
run: |
74-
wget -O sbsh https://github.com/eminwux/sbsh/releases/download/v0.5.0/sbsh-linux-amd64
74+
wget -O sbsh https://github.com/eminwux/sbsh/releases/download/v0.6.0/sbsh-linux-amd64
7575
chmod +x sbsh && sudo install -m 0755 sbsh /usr/local/bin/sbsh
7676
sudo ln -f /usr/local/bin/sbsh /usr/local/bin/sb
7777
@@ -138,7 +138,7 @@ Install sbsh in your GitLab CI pipeline:
138138
before_script:
139139
- |
140140
if ! command -v sbsh &> /dev/null; then
141-
wget -O sbsh https://github.com/eminwux/sbsh/releases/download/v0.5.0/sbsh-linux-amd64
141+
wget -O sbsh https://github.com/eminwux/sbsh/releases/download/v0.6.0/sbsh-linux-amd64
142142
chmod +x sbsh && sudo install -m 0755 sbsh /usr/local/bin/sbsh
143143
sudo ln -f /usr/local/bin/sbsh /usr/local/bin/sb
144144
fi
@@ -153,7 +153,7 @@ test:
153153
before_script:
154154
- apt-get update && apt-get install -y wget procps
155155
- |
156-
wget -O sbsh https://github.com/eminwux/sbsh/releases/download/v0.5.0/sbsh-linux-amd64
156+
wget -O sbsh https://github.com/eminwux/sbsh/releases/download/v0.6.0/sbsh-linux-amd64
157157
chmod +x sbsh && sudo install -m 0755 sbsh /usr/local/bin/sbsh
158158
sudo ln -f /usr/local/bin/sbsh /usr/local/bin/sb
159159
script:
@@ -209,7 +209,7 @@ Install sbsh in your Jenkins pipeline:
209209

210210
```groovy
211211
sh '''
212-
wget -O sbsh https://github.com/eminwux/sbsh/releases/download/v0.5.0/sbsh-linux-amd64
212+
wget -O sbsh https://github.com/eminwux/sbsh/releases/download/v0.6.0/sbsh-linux-amd64
213213
chmod +x sbsh && sudo mv sbsh /usr/local/bin/
214214
sudo ln -f /usr/local/bin/sbsh /usr/local/bin/sb
215215
'''
@@ -223,7 +223,7 @@ pipeline {
223223
agent any
224224
225225
environment {
226-
SBSH_VERSION = 'v0.5.0'
226+
SBSH_VERSION = 'v0.6.0'
227227
}
228228
229229
stages {
@@ -288,7 +288,7 @@ node {
288288
289289
stage('Setup') {
290290
sh '''
291-
wget -O sbsh https://github.com/eminwux/sbsh/releases/download/v0.5.0/sbsh-linux-amd64
291+
wget -O sbsh https://github.com/eminwux/sbsh/releases/download/v0.6.0/sbsh-linux-amd64
292292
chmod +x sbsh && sudo install -m 0755 sbsh /usr/local/bin/sbsh
293293
sudo ln -f /usr/local/bin/sbsh /usr/local/bin/sb
294294
'''

‎docs/container.md‎

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -17,23 +17,23 @@ sbsh images are available on Docker Hub at `docker.io/eminwux/sbsh`. Images are
1717
### AMD64 (x86_64)
1818

1919
```bash
20-
docker pull docker.io/eminwux/sbsh:v0.5.0-linux-amd64
20+
docker pull docker.io/eminwux/sbsh:v0.6.0-linux-amd64
2121
```
2222

2323
### ARM64
2424

2525
```bash
26-
docker pull docker.io/eminwux/sbsh:v0.5.0-linux-arm64
26+
docker pull docker.io/eminwux/sbsh:v0.6.0-linux-arm64
2727
```
2828

2929
### Using Docker Hub Short Syntax
3030

3131
```bash
3232
# AMD64
33-
docker pull eminwux/sbsh:v0.5.0-linux-amd64
33+
docker pull eminwux/sbsh:v0.6.0-linux-amd64
3434

3535
# ARM64
36-
docker pull eminwux/sbsh:v0.5.0-linux-arm64
36+
docker pull eminwux/sbsh:v0.6.0-linux-arm64
3737
```
3838

3939
## Image Architecture
@@ -76,7 +76,7 @@ Runs a **supervisor attached to a terminal**. This is the default behavior when
7676
**Example Dockerfile:**
7777

7878
```dockerfile
79-
FROM docker.io/eminwux/sbsh:v0.5.0-linux-amd64
79+
FROM docker.io/eminwux/sbsh:v0.6.0-linux-amd64
8080
CMD ["/bin/sbsh"]
8181
```
8282

@@ -100,7 +100,7 @@ Runs **just a terminal** without a supervisor. The supervisor is launched extern
100100
**Example Dockerfile:**
101101

102102
```dockerfile
103-
FROM docker.io/eminwux/sbsh:v0.5.0-linux-amd64
103+
FROM docker.io/eminwux/sbsh:v0.6.0-linux-amd64
104104
CMD ["/bin/sbsh", "terminal", "--name", "my-terminal"]
105105
```
106106

@@ -142,7 +142,7 @@ Run sbsh with an attached supervisor and terminal:
142142
```bash
143143
docker run -it --rm \
144144
-v ~/.sbsh:/root/.sbsh \
145-
docker.io/eminwux/sbsh:v0.5.0-linux-amd64 \
145+
docker.io/eminwux/sbsh:v0.6.0-linux-amd64 \
146146
sbsh
147147
```
148148

@@ -161,7 +161,7 @@ Launch a terminal that runs independently (no supervisor initially). **Important
161161
docker run -d \
162162
--name my-sbsh-terminal \
163163
-v ~/.sbsh:/root/.sbsh \
164-
docker.io/eminwux/sbsh:v0.5.0-linux-amd64 \
164+
docker.io/eminwux/sbsh:v0.6.0-linux-amd64 \
165165
sbsh terminal --name my-terminal
166166
```
167167

@@ -210,7 +210,7 @@ docker volume create sbsh-data
210210

211211
docker run -it --rm \
212212
-v sbsh-data:/root/.sbsh \
213-
docker.io/eminwux/sbsh:v0.5.0-linux-amd64 \
213+
docker.io/eminwux/sbsh:v0.6.0-linux-amd64 \
214214
sbsh
215215
```
216216

@@ -221,7 +221,7 @@ For direct access to files from the host:
221221
```bash
222222
docker run -it --rm \
223223
-v /home/user/.sbsh:/root/.sbsh \
224-
docker.io/eminwux/sbsh:v0.5.0-linux-amd64 \
224+
docker.io/eminwux/sbsh:v0.6.0-linux-amd64 \
225225
sbsh
226226
```
227227

@@ -234,7 +234,7 @@ Launch a supervisor with an attached terminal:
234234
```bash
235235
docker run -it --rm \
236236
-v ~/.sbsh:/root/.sbsh \
237-
docker.io/eminwux/sbsh:v0.5.0-linux-amd64 \
237+
docker.io/eminwux/sbsh:v0.6.0-linux-amd64 \
238238
sbsh -p terraform-prd
239239
```
240240

@@ -246,7 +246,7 @@ Create a terminal that runs independently:
246246
docker run -d \
247247
--name terraform-terminal \
248248
-v ~/.sbsh:/root/.sbsh \
249-
docker.io/eminwux/sbsh:v0.5.0-linux-amd64 \
249+
docker.io/eminwux/sbsh:v0.6.0-linux-amd64 \
250250
sbsh terminal --name terraform-prd -p terraform-prd
251251
```
252252

@@ -258,19 +258,19 @@ List terminals, attach, or manage sessions:
258258
# List terminals
259259
docker run --rm \
260260
-v ~/.sbsh:/root/.sbsh \
261-
docker.io/eminwux/sbsh:v0.5.0-linux-amd64 \
261+
docker.io/eminwux/sbsh:v0.6.0-linux-amd64 \
262262
sb get terminals
263263

264264
# Attach to a terminal
265265
docker run -it --rm \
266266
-v ~/.sbsh:/root/.sbsh \
267-
docker.io/eminwux/sbsh:v0.5.0-linux-amd64 \
267+
docker.io/eminwux/sbsh:v0.6.0-linux-amd64 \
268268
sb attach my-terminal
269269

270270
# List profiles
271271
docker run --rm \
272272
-v ~/.sbsh:/root/.sbsh \
273-
docker.io/eminwux/sbsh:v0.5.0-linux-amd64 \
273+
docker.io/eminwux/sbsh:v0.6.0-linux-amd64 \
274274
sb get profiles
275275
```
276276

@@ -283,7 +283,7 @@ You can use the sbsh image as a base for custom Dockerfiles:
283283
Use `CMD ["/bin/sbsh"]` for interactive development where you want the supervisor attached:
284284

285285
```dockerfile
286-
FROM docker.io/eminwux/sbsh:v0.5.0-linux-amd64
286+
FROM docker.io/eminwux/sbsh:v0.6.0-linux-amd64
287287

288288
# Install additional tools
289289
RUN apt-get update && apt-get install -y \
@@ -319,7 +319,7 @@ This runs an interactive terminal with an attached supervisor. Press `Ctrl-]` tw
319319
Use `CMD ["/bin/sbsh", "terminal"]` for background terminals that run independently. **Important**: Always specify `--name` to identify the terminal for later attachment:
320320

321321
```dockerfile
322-
FROM docker.io/eminwux/sbsh:v0.5.0-linux-amd64
322+
FROM docker.io/eminwux/sbsh:v0.6.0-linux-amd64
323323

324324
# Install additional tools
325325
RUN apt-get update && apt-get install -y \
@@ -364,7 +364,7 @@ version: "3.8"
364364

365365
services:
366366
sbsh:
367-
image: docker.io/eminwux/sbsh:v0.5.0-linux-amd64
367+
image: docker.io/eminwux/sbsh:v0.6.0-linux-amd64
368368
container_name: sbsh
369369
volumes:
370370
- ~/.sbsh:/root/.sbsh
@@ -394,8 +394,8 @@ sbsh images are available for multiple architectures:
394394
Docker automatically selects the correct image for your platform:
395395

396396
```bash
397-
docker pull eminwux/sbsh:v0.5.0-linux-amd64
398-
docker pull eminwux/sbsh:v0.5.0-linux-arm64
397+
docker pull eminwux/sbsh:v0.6.0-linux-amd64
398+
docker pull eminwux/sbsh:v0.6.0-linux-arm64
399399
```
400400

401401
### Using Docker Buildx
@@ -405,7 +405,7 @@ For multi-architecture builds, use Docker Buildx:
405405
```bash
406406
docker buildx create --use
407407
docker buildx build --platform linux/amd64,linux/arm64 \
408-
-t eminwux/sbsh:v0.5.0 \
408+
-t eminwux/sbsh:v0.6.0 \
409409
--push .
410410
```
411411

@@ -419,7 +419,7 @@ If you need to run Docker commands inside sbsh containers, you can use Docker-in
419419
docker run -it --rm \
420420
-v ~/.sbsh:/root/.sbsh \
421421
-v /var/run/docker.sock:/var/run/docker.sock \
422-
docker.io/eminwux/sbsh:v0.5.0-linux-amd64 \
422+
docker.io/eminwux/sbsh:v0.6.0-linux-amd64 \
423423
sbsh
424424
```
425425

@@ -431,7 +431,7 @@ Then install Docker client inside the container or use a profile that includes i
431431
docker run -it --rm \
432432
-v ~/.sbsh:/root/.sbsh \
433433
--privileged \
434-
docker.io/eminwux/sbsh:v0.5.0-linux-amd64 \
434+
docker.io/eminwux/sbsh:v0.6.0-linux-amd64 \
435435
sbsh
436436
```
437437

@@ -458,7 +458,7 @@ spec:
458458
spec:
459459
containers:
460460
- name: sbsh
461-
image: docker.io/eminwux/sbsh:v0.5.0-linux-amd64
461+
image: docker.io/eminwux/sbsh:v0.6.0-linux-amd64
462462
command: ["/bin/sbsh", "terminal", "--name", "k8s-terminal"]
463463
volumeMounts:
464464
- name: sbsh-data
@@ -501,7 +501,7 @@ spec:
501501
docker run -it --rm \
502502
--user $(id -u):$(id -g) \
503503
-v ~/.sbsh:/home/user/.sbsh \
504-
docker.io/eminwux/sbsh:v0.5.0-linux-amd64 \
504+
docker.io/eminwux/sbsh:v0.6.0-linux-amd64 \
505505
sbsh
506506
```
507507

@@ -545,8 +545,8 @@ spec:
545545
**Solutions**:
546546

547547
- Pull the correct architecture image:
548-
- AMD64: `docker.io/eminwux/sbsh:v0.5.0-linux-amd64`
549-
- ARM64: `docker.io/eminwux/sbsh:v0.5.0-linux-arm64`
548+
- AMD64: `docker.io/eminwux/sbsh:v0.6.0-linux-amd64`
549+
- ARM64: `docker.io/eminwux/sbsh:v0.6.0-linux-arm64`
550550
- Use `docker manifest inspect` to check available architectures
551551
- Verify host architecture: `uname -m`
552552

@@ -564,7 +564,7 @@ spec:
564564
## Best Practices
565565

566566
1. **Use Named Volumes**: For production, use named volumes instead of bind mounts for better portability
567-
2. **Version Pinning**: Always pin to specific version tags (e.g., `v0.5.0-linux-amd64`) instead of `latest`
567+
2. **Version Pinning**: Always pin to specific version tags (e.g., `v0.6.0-linux-amd64`) instead of `latest`
568568
3. **Profile Management**: Store profiles in version control and mount them as volumes
569569
4. **Resource Limits**: Set appropriate CPU and memory limits for containers
570570
5. **Security**: Avoid using `--privileged` unless absolutely necessary

‎docs/site/getting-started.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ export OS=linux # Options: linux, darwin, freebsd
1414
export ARCH=amd64 # Options: amd64, arm64
1515

1616
# Install sbsh
17-
curl -L -o sbsh https://github.com/eminwux/sbsh/releases/download/v0.5.0/sbsh-${OS}-${ARCH} && \
17+
curl -L -o sbsh https://github.com/eminwux/sbsh/releases/download/v0.6.0/sbsh-${OS}-${ARCH} && \
1818
chmod +x sbsh && \
1919
sudo install -m 0755 sbsh /usr/local/bin/sbsh && \
2020
sudo ln -f /usr/local/bin/sbsh /usr/local/bin/sb

0 commit comments

Comments
 (0)