Update Gemini Code verbiage -> Gemini CLI

- Did not update details that impact GC execution. Meaning packages are still named gemini-code (for now) and things that import them still import them as gemini-code.
This commit is contained in:
Taylor Mullen 2025-05-14 13:51:17 -07:00 committed by N. Taylor Mullen
parent aec6c0861e
commit 5b4c9e8e43
7 changed files with 19 additions and 33 deletions

View File

@ -1,6 +1,6 @@
# .github/workflows/ci.yml # .github/workflows/ci.yml
name: Gemini Code CI name: Gemini CLI CI
on: on:
push: push:

View File

@ -31,15 +31,15 @@ All submissions, including submissions by project members, require review. We
use [GitHub pull requests](https://docs.github.com/articles/about-pull-requests) use [GitHub pull requests](https://docs.github.com/articles/about-pull-requests)
for this purpose. for this purpose.
### gemini-code alias ### gemini-cli alias
During development phase, you can use the following to create an alias for During development phase, you can use the following to create an alias for
the command line tool: the command line tool:
```bash ```bash
$ npm run build $ npm run build
$ alias gemini-code="node /path/to/gemini-code/packages/cli/dist/index.js" $ alias gemini-code="node /path/to/gemini-cli/packages/cli/dist/index.js"
$ gemini-code $ gemini
██████╗ ███████╗███╗ ███╗██╗███╗ ██╗██╗ ██████╗ ███████╗███╗ ███╗██╗███╗ ██╗██╗
██╔════╝ ██╔════╝████╗ ████║██║████╗ ██║██║ ██╔════╝ ██╔════╝████╗ ████║██║████╗ ██║██║
██║ ███╗█████╗ ██╔████╔██║██║██╔██╗ ██║██║ ██║ ███╗█████╗ ██╔████╔██║██║██╔██╗ ██║██║
@ -47,25 +47,13 @@ $ gemini-code
╚██████╔╝███████╗██║ ╚═╝ ██║██║██║ ╚████║██║ ╚██████╔╝███████╗██║ ╚═╝ ██║██║██║ ╚████║██║
╚═════╝ ╚══════╝╚═╝ ╚═╝╚═╝╚═╝ ╚═══╝╚═╝ ╚═════╝ ╚══════╝╚═╝ ╚═╝╚═╝╚═╝ ╚═══╝╚═╝
██████╗ ██████╗ ██████╗ ███████╗
██╔════╝██╔═══██╗██╔══██╗██╔════╝
██║ ██║ ██║██║ ██║█████╗
██║ ██║ ██║██║ ██║██╔══╝
╚██████╗╚██████╔╝██████╔╝███████╗
╚═════╝ ╚═════╝ ╚═════╝ ╚══════╝
Tips for getting started: Tips for getting started:
1. /help for more information. 1. /help for more information.
2. Ask coding questions, edit code or run commands. 2. Ask coding questions, edit code or run commands.
3. Be specific for the best results. 3. Be specific for the best results.
cwd: /Users/jbd/gemini-code cwd: /Users/jbd/gemini-cli
╭────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ ╭────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ > Enter your message or use tools... │ │ > Enter your message or use tools... │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ ╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
? for shortcuts Gemini
Note: Flickering may occur in iTerm.
``` ```

View File

@ -30,7 +30,7 @@ ENV PATH=$PATH:/usr/local/share/npm-global/bin
# switch to non-root user node # switch to non-root user node
USER node USER node
# install gemini-code and clean up # install gemini-cli and clean up
COPY packages/cli/dist/gemini-code-cli-*.tgz /usr/local/share/npm-global/gemini-code-cli.tgz COPY packages/cli/dist/gemini-code-cli-*.tgz /usr/local/share/npm-global/gemini-code-cli.tgz
COPY packages/server/dist/gemini-code-server-*.tgz /usr/local/share/npm-global/gemini-code-server.tgz COPY packages/server/dist/gemini-code-server-*.tgz /usr/local/share/npm-global/gemini-code-server.tgz
RUN npm install -g /usr/local/share/npm-global/gemini-code-cli.tgz /usr/local/share/npm-global/gemini-code-server.tgz \ RUN npm install -g /usr/local/share/npm-global/gemini-code-cli.tgz /usr/local/share/npm-global/gemini-code-server.tgz \

View File

@ -1,10 +1,8 @@
# Gemini Code # Gemini CLI
[![Gemini Code CI](https://github.com/google-gemini/gemini-code/actions/workflows/ci.yml/badge.svg)](https://github.com/google-gemini/gemini-code/actions/workflows/ci.yml) [![Gemini CLI CI](https://github.com/google-gemini/gemini-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/google-gemini/gemini-cli/actions/workflows/ci.yml)
**Disclaimer:** This README.md was created by gemini-code and this project was developed rapidly and currently lacks comprehensive testing, and other quality-of-life features common in mature projects. This repository contains the Gemini CLI tool.
This repository contains the Gemini Code CLI tool.
## Setup ## Setup
@ -39,13 +37,13 @@ This command installs dependencies and builds the entire project, including the
## Running ## Running
To start the Gemini Code CLI, run the following command from the root directory: To start the Gemini CLI, run the following command from the root directory:
```bash ```bash
npm start npm start
``` ```
This command starts the Gemini Code CLI. This command starts the Gemini CLI.
## Debugging ## Debugging
@ -60,9 +58,9 @@ To debug the CLI application using VS Code:
Alternatively, you can use the "Launch Program" configuration in VS Code if you prefer to launch the currently open file directly, but the "Attach" method is generally recommended for debugging the main CLI entry point. Alternatively, you can use the "Launch Program" configuration in VS Code if you prefer to launch the currently open file directly, but the "Attach" method is generally recommended for debugging the main CLI entry point.
## Using Gemini Code source in other directories ## Using Gemini CLI source in other directories
To test your local version of `gemini` in other directories on your system, you can use `npm link`. Note, this is not the same as globally installing the released version of Gemini Code via `npm install -g @gemini-code/cli`. Rather, this creates a global symlink to your local project. To test your local version of `gemini` in other directories on your system, you can use `npm link`. Note, this is not the same as globally installing the released version of Gemini CLI via `npm install -g @gemini-code/cli`. Rather, this creates a global symlink to your local project.
From the root of this repository, run: From the root of this repository, run:
@ -110,7 +108,7 @@ On MacOS, `gemini` uses Seatbelt (`sandbox-exec`) under a `minimal` profile (see
For stronger container-based sandboxing on MacOS or other platforms, you can set `GEMINI_CODE_SANDBOX=true|docker|podman|<command>` in your environment or `.env` file. The specified command (or if `true` then either `docker` or `podman`) must be installed on the host machine. Once enabled, `npm run build:all` will build a minimal container ("sandbox") image and `npm start` will launch inside a fresh instance of that container. The first build can take 20-30s (mostly due to downloading of the base image) but after that both build and start overhead should be minimal. Default builds (`npm run build`) will not rebuild the sandbox. For stronger container-based sandboxing on MacOS or other platforms, you can set `GEMINI_CODE_SANDBOX=true|docker|podman|<command>` in your environment or `.env` file. The specified command (or if `true` then either `docker` or `podman`) must be installed on the host machine. Once enabled, `npm run build:all` will build a minimal container ("sandbox") image and `npm start` will launch inside a fresh instance of that container. The first build can take 20-30s (mostly due to downloading of the base image) but after that both build and start overhead should be minimal. Default builds (`npm run build`) will not rebuild the sandbox.
Container-based sandboxing mounts the project directory (and system temp directory) with read-write access and is started/stopped/removed automatically as you start/stop Gemini Code. Files created within the sandbox should be automatically mapped to your user/group on host machine. You can easily specify additional mounts, ports, or environment variables by setting `SANDBOX_{MOUNTS,PORTS,ENV}` as needed. You can also fully customize the sandbox for your projects by creating the files `.gemini/sandbox.Dockerfile` and/or `.gemini/sandbox.bashrc` under your project settings directory `.gemini`. Container-based sandboxing mounts the project directory (and system temp directory) with read-write access and is started/stopped/removed automatically as you start/stop Gemini CLI. Files created within the sandbox should be automatically mapped to your user/group on host machine. You can easily specify additional mounts, ports, or environment variables by setting `SANDBOX_{MOUNTS,PORTS,ENV}` as needed. You can also fully customize the sandbox for your projects by creating the files `.gemini/sandbox.Dockerfile` and/or `.gemini/sandbox.bashrc` under your project settings directory `.gemini`.
### Attaching from VSCode ### Attaching from VSCode

View File

@ -1,6 +1,6 @@
# Gemini Code CLI # Gemini CLI
This package contains the core command-line interface for Gemini Code. This package contains the core command-line interface for Gemini CLI.
## Setup ## Setup
@ -28,7 +28,7 @@ This command executes the TypeScript compiler (`tsc`) as defined in this package
## Running ## Running
To start the Gemini Code CLI directly from this directory: To start the Gemini CLI directly from this directory:
```bash ```bash
npm start npm start

View File

@ -1,7 +1,7 @@
{ {
"name": "@gemini-code/cli", "name": "@gemini-code/cli",
"version": "0.1.0", "version": "0.1.0",
"description": "Gemini Code CLI", "description": "Gemini CLI",
"type": "module", "type": "module",
"main": "dist/index.js", "main": "dist/index.js",
"bin": { "bin": {

View File

@ -1,7 +1,7 @@
{ {
"name": "@gemini-code/server", "name": "@gemini-code/server",
"version": "0.1.0", "version": "0.1.0",
"description": "Gemini Code Server", "description": "Gemini CLI Server",
"type": "module", "type": "module",
"main": "dist/index.js", "main": "dist/index.js",
"scripts": { "scripts": {