summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBrandon Keiji <[email protected]>2025-04-17 11:59:12 -0700
committerGitHub <[email protected]>2025-04-17 11:59:12 -0700
commit898a83031c695f6da8705848ebe9998a7b626019 (patch)
tree372793ad3313b62aca33b36f5aa2bed66e717d2b /README.md
parentf10aaf7e7e063ffa29832223a241623a1c84333e (diff)
docs: Add setup instructions for API key to README (#1)
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
index 55d04ebf..063cc60f 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,20 @@ This repository contains the Gemini Code CLI tool.
This project uses Gerrit for version control. For details on the development workflow, including how to clone the repository and contribute changes, please refer to the [Gerrit Dev Workflows](http://go/gerrit-dev-workflows).
+## Setup
+
+1. **Get a Gemini API Key:** Obtain your API key from Google AI Studio: [https://aistudio.google.com/app/apikey](https://aistudio.google.com/app/apikey)
+2. **Set Environment Variable:** Set the `GEMINI_API_KEY` environment variable to your obtained key. You can do this temporarily in your current shell session:
+ ```bash
+ export GEMINI_API_KEY="YOUR_API_KEY"
+ ```
+ Or add it to your shell's configuration file (like `~/.bashrc`, `~/.zshrc`, or `~/.profile`) for persistence:
+ ```bash
+ echo 'export GEMINI_API_KEY="YOUR_API_KEY"' >> ~/.bashrc # Or your preferred shell config file
+ source ~/.bashrc # Reload the config
+ ```
+ Replace `"YOUR_API_KEY"` with your actual key.
+
## Building
To build the entire project, including the CLI package, run the following command from the root directory: