Skip to content

Commit 87e77ea

Browse files
committed
docs: 📄updated README.md
1 parent ea15338 commit 87e77ea

2 files changed

Lines changed: 6 additions & 18 deletions

File tree

.markdownlint.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
---
2+
MD013: false

README.md

Lines changed: 4 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
# Gemini CLI Container<!-- omit from toc -->
22

33
- [Container Architecture](#container-architecture)
4-
- [Structure of `Dockerfile`](#structure-of-dockerfile)
5-
- [Security Features](#security-features)
64
- [Building the Container Image](#building-the-container-image)
75
- [Build Arguments](#build-arguments)
86
- [Authentication Setup](#authentication-setup)
@@ -30,26 +28,13 @@
3028
- [File Access Issues](#file-access-issues)
3129
- [Container Issues](#container-issues)
3230

33-
A containerized version of Google's Gemini CLI tool, built with security and
34-
portability in mind. This container provides a rootless, distroless environment
35-
for running Gemini CLI commands while maintaining persistent authentication and
36-
seamless file access.
31+
A containerized version of Google's Gemini CLI tool. This container provides a rootless environment
32+
for running Gemini CLI commands while maintaining persistent authentication and seamless file access.
3733

3834
## Container Architecture
3935

40-
### Structure of `Dockerfile`
41-
42-
This container uses a multi-stage build process for optimal security and size:
43-
44-
- **Stage 1 (Builder)**: Uses `node:20-slim` to install the `@google/gemini-cli` package
45-
- **Stage 2 (OS Prep)**: Uses `debian:stable-slim` to prepare user configuration files
46-
- **Final Stage**: Uses `gcr.io/distroless/nodejs20-debian12:nonroot` for a minimal, secure runtime
47-
48-
### Security Features
49-
5036
- **Rootless execution**: Runs as user `gemini` (UID 1000) instead of root
51-
- **Distroless base**: Minimal attack surface with no shell or package managers
52-
- **Non-privileged user**: Enhanced security through principle of least privilege
37+
- **Minimal base**: Uses `node:22-slim` which provides a smaller attack surface
5338

5439
## Building the Container Image
5540

@@ -103,6 +88,7 @@ To verify your authentication is working:
10388
```bash
10489
docker run -it -v $HOME:/home/gemini --rm gemini-cli:dev --help
10590
```
91+
10692
If authentication is successful, you should see the Gemini CLI help without authentication prompts.
10793

10894
### Authentication via GEMINI_API_KEY

0 commit comments

Comments
 (0)