Updates to use markdoc files and render on GH.

This commit is contained in:
g-samroberts
2026-03-25 22:31:25 -07:00
parent c1e4dbd157
commit 913092aa8a
2 changed files with 22 additions and 14 deletions
+3
View File
@@ -22,3 +22,6 @@ Makefile eol=lf
*.eot binary
*.ttf binary
*.otf binary
# Configure GitHub to treat Markdoc files as Markdown
*.mdoc linguist-language=Markdown
@@ -23,34 +23,33 @@ installation methods, and release types.
We recommend most users install Gemini CLI using one of the following
installation methods:
- npm
- Homebrew
- MacPorts
- Anaconda
Note that Gemini CLI comes pre-installed on
[**Cloud Shell**](https://docs.cloud.google.com/shell/docs) and
[**Cloud Workstations**](https://cloud.google.com/workstations).
### Install globally with npm
{% tabs %}
{% tabitem label="npm" %}
Install globally with npm:
```bash
npm install -g @google/gemini-cli
```
{% /tabitem %}
### Install globally with Homebrew (macOS/Linux)
{% tabitem label="Homebrew" %}
Install globally with Homebrew (macOS/Linux):
```bash
brew install gemini-cli
```
{% /tabitem %}
### Install globally with MacPorts (macOS)
{% tabitem label="MacPorts" %}
Install globally with MacPorts (macOS):
```bash
sudo port install gemini-cli
```
{% /tabitem %}
### Install with Anaconda (for restricted environments)
{% tabitem label="Anaconda" %}
Install with Anaconda (for restricted environments):
```bash
# Create and activate a new environment
@@ -60,6 +59,12 @@ conda activate gemini_env
# Install Gemini CLI globally via npm (inside the environment)
npm install -g @google/gemini-cli
```
{% /tabitem %}
{% /tabs %}
Note that Gemini CLI comes pre-installed on
[**Cloud Shell**](https://docs.cloud.google.com/shell/docs) and
[**Cloud Workstations**](https://cloud.google.com/workstations).
## Run Gemini CLI
@@ -102,7 +107,7 @@ the default way that the CLI executes tools that might have side effects.
to run the CLI.
```bash
# Run the published sandbox image
docker run --rm -it us-docker.pkg.dev/gemini-code-dev/gemini-cli/sandbox:0.1.1
docker run --rm -it us-docker.pkg.dev/gemini-code-dev/gemini-cli/sandbox:latest
```
- **Using the `--sandbox` flag:** If you have Gemini CLI installed locally
(using the standard installation described above), you can instruct it to run