|
1 | | -# Gemini CLI |
| 1 | +# Pantheon CLI |
2 | 2 |
|
3 | | -[](https://github.com/google-gemini/gemini-cli/actions/workflows/ci.yml) |
4 | | - |
5 | | - |
6 | | - |
7 | | -This repository contains the Gemini CLI, a command-line AI workflow tool that connects to your |
8 | | -tools, understands your code and accelerates your workflows. |
9 | | - |
10 | | -With the Gemini CLI you can: |
11 | | - |
12 | | -- Query and edit large codebases in and beyond Gemini's 1M token context window. |
13 | | -- Generate new apps from PDFs or sketches, using Gemini's multimodal capabilities. |
14 | | -- Automate operational tasks, like querying pull requests or handling complex rebases. |
15 | | -- Use tools and MCP servers to connect new capabilities, including [media generation with Imagen, |
16 | | - Veo or Lyria](https://github.com/GoogleCloudPlatform/vertex-ai-creative-studio/tree/main/experiments/mcp-genmedia) |
17 | | -- Ground your queries with the [Google Search](https://ai.google.dev/gemini-api/docs/grounding) |
18 | | - tool, built into Gemini. |
| 3 | +<img width="1256" height="300" alt="Image" src="https://private-user-images.githubusercontent.com/46667721/472695511-ab7a5b43-0531-4870-a8a2-93f6709fb67b.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3NTM5MDc2MzksIm5iZiI6MTc1MzkwNzMzOSwicGF0aCI6Ii80NjY2NzcyMS80NzI2OTU1MTEtYWI3YTViNDMtMDUzMS00ODcwLWE4YTItOTNmNjcwOWZiNjdiLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNTA3MzAlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjUwNzMwVDIwMjg1OVomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTM5MzU1NTAzNTBkMDZmNmQ1ZmM4NDgxMWUxNzYyZWMzYTFlNDcwMDU2NzUyZWQ1ZjNmYzUyNTkyZDFiMjU3NGQmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0In0.duSGtnaa7ONSzdNvRoqd-h6x5j4AFM1UQ9S7do5Vk-8" /> |
19 | 4 |
|
20 | 5 | ## Quickstart |
21 | 6 |
|
22 | | -You have two options to install Gemini CLI. |
| 7 | +You have two options to install Pantheon CLI. |
23 | 8 |
|
24 | 9 | ### With Node |
25 | 10 |
|
26 | 11 | 1. **Prerequisites:** Ensure you have [Node.js version 20](https://nodejs.org/en/download) or higher installed. |
27 | 12 | 2. **Run the CLI:** Execute the following command in your terminal: |
28 | 13 |
|
29 | 14 | ```bash |
30 | | - npx https://github.com/google-gemini/gemini-cli |
31 | | - ``` |
32 | | - |
33 | | - Or install it with: |
34 | | - |
35 | | - ```bash |
36 | | - npm install -g @google/gemini-cli |
| 15 | + npm run build |
37 | 16 | ``` |
38 | 17 |
|
39 | 18 | Then, run the CLI from anywhere: |
40 | 19 |
|
41 | 20 | ```bash |
42 | | - gemini |
| 21 | + npm run start |
43 | 22 | ``` |
44 | 23 |
|
45 | | -### With Homebrew |
46 | | - |
47 | | -1. **Prerequisites:** Ensure you have [Homebrew](https://brew.sh/) installed. |
48 | | -2. **Install the CLI** Execute the following command in your terminal: |
49 | | - |
50 | | - ```bash |
51 | | - brew install gemini-cli |
52 | | - ``` |
53 | | - |
54 | | - Then, run the CLI from anywhere: |
55 | | - |
56 | | - ```bash |
57 | | - gemini |
58 | | - ``` |
59 | 24 |
|
60 | 25 | ### Common Configuration steps |
61 | 26 |
|
62 | 27 | 3. **Pick a color theme** |
63 | 28 | 4. **Authenticate:** When prompted, sign in with your personal Google account. This will grant you up to 60 model requests per minute and 1,000 model requests per day using Gemini. |
64 | 29 |
|
65 | | -You are now ready to use the Gemini CLI! |
| 30 | +You are now ready to use the Pantheon CLI! |
66 | 31 |
|
67 | 32 | ### Use a Gemini API key: |
68 | 33 |
|
@@ -93,119 +58,7 @@ The Vertex AI API provides a [free tier](https://cloud.google.com/vertex-ai/gene |
93 | 58 |
|
94 | 59 | For other authentication methods, including Google Workspace accounts, see the [authentication](./docs/cli/authentication.md) guide. |
95 | 60 |
|
96 | | -## Examples |
97 | | - |
98 | | -Once the CLI is running, you can start interacting with Gemini from your shell. |
99 | | - |
100 | | -You can start a project from a new directory: |
101 | | - |
102 | | -```sh |
103 | | -cd new-project/ |
104 | | -gemini |
105 | | -> Write me a Gemini Discord bot that answers questions using a FAQ.md file I will provide |
106 | | -``` |
107 | | - |
108 | | -Or work with an existing project: |
109 | | - |
110 | | -```sh |
111 | | -git clone https://github.com/google-gemini/gemini-cli |
112 | | -cd gemini-cli |
113 | | -gemini |
114 | | -> Give me a summary of all of the changes that went in yesterday |
115 | | -``` |
116 | | - |
117 | | -### Next steps |
118 | | - |
119 | | -- Learn how to [contribute to or build from the source](./CONTRIBUTING.md). |
120 | | -- Explore the available **[CLI Commands](./docs/cli/commands.md)**. |
121 | | -- If you encounter any issues, review the **[troubleshooting guide](./docs/troubleshooting.md)**. |
122 | | -- For more comprehensive documentation, see the [full documentation](./docs/index.md). |
123 | | -- Take a look at some [popular tasks](#popular-tasks) for more inspiration. |
124 | | -- Check out our **[Official Roadmap](./ROADMAP.md)** |
125 | | - |
126 | | -### Troubleshooting |
127 | | - |
128 | | -Head over to the [troubleshooting guide](docs/troubleshooting.md) if you're |
129 | | -having issues. |
130 | | - |
131 | | -## Popular tasks |
132 | | - |
133 | | -### Explore a new codebase |
134 | | - |
135 | | -Start by `cd`ing into an existing or newly-cloned repository and running `gemini`. |
136 | | - |
137 | | -```text |
138 | | -> Describe the main pieces of this system's architecture. |
139 | | -``` |
140 | | - |
141 | | -```text |
142 | | -> What security mechanisms are in place? |
143 | | -``` |
144 | | - |
145 | | -```text |
146 | | -> Provide a step-by-step dev onboarding doc for developers new to the codebase. |
147 | | -``` |
148 | | - |
149 | | -```text |
150 | | -> Summarize this codebase and highlight the most interesting patterns or techniques I could learn from. |
151 | | -``` |
152 | | - |
153 | | -```text |
154 | | -> Identify potential areas for improvement or refactoring in this codebase, highlighting parts that appear fragile, complex, or hard to maintain. |
155 | | -``` |
156 | | - |
157 | | -```text |
158 | | -> Which parts of this codebase might be challenging to scale or debug? |
159 | | -``` |
160 | | - |
161 | | -```text |
162 | | -> Generate a README section for the [module name] module explaining what it does and how to use it. |
163 | | -``` |
164 | | - |
165 | | -```text |
166 | | -> What kind of error handling and logging strategies does the project use? |
167 | | -``` |
168 | | - |
169 | | -```text |
170 | | -> Which tools, libraries, and dependencies are used in this project? |
171 | | -``` |
172 | | - |
173 | | -### Work with your existing code |
174 | | - |
175 | | -```text |
176 | | -> Implement a first draft for GitHub issue #123. |
177 | | -``` |
178 | | - |
179 | | -```text |
180 | | -> Help me migrate this codebase to the latest version of Java. Start with a plan. |
181 | | -``` |
182 | | - |
183 | | -### Automate your workflows |
184 | | - |
185 | | -Use MCP servers to integrate your local system tools with your enterprise collaboration suite. |
186 | | - |
187 | | -```text |
188 | | -> Make me a slide deck showing the git history from the last 7 days, grouped by feature and team member. |
189 | | -``` |
190 | | - |
191 | | -```text |
192 | | -> Make a full-screen web app for a wall display to show our most interacted-with GitHub issues. |
193 | | -``` |
194 | | - |
195 | | -### Interact with your system |
196 | | - |
197 | | -```text |
198 | | -> Convert all the images in this directory to png, and rename them to use dates from the exif data. |
199 | | -``` |
200 | | - |
201 | | -```text |
202 | | -> Organize my PDF invoices by month of expenditure. |
203 | | -``` |
204 | | - |
205 | | -### Uninstall |
206 | | - |
207 | | -Head over to the [Uninstall](docs/Uninstall.md) guide for uninstallation instructions. |
208 | 61 |
|
209 | | -## Terms of Service and Privacy Notice |
| 62 | +## Acknowledgments |
210 | 63 |
|
211 | | -For details on the terms of service and privacy notice applicable to your use of Gemini CLI, see the [Terms of Service and Privacy Notice](./docs/tos-privacy.md). |
| 64 | +This project is based on [Google Gemini CLI](https://github.com/google-gemini/gemini-cli). We acknowledge and appreciate the excellent work of the Gemini CLI team. Our main contribution focuses on parser-level adaptations to better support Qwen-Coder models. |
0 commit comments