@dgxo/mashadevcli 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +202 -0
- package/README.md +393 -0
- package/bundle/builtin/skill-creator/SKILL.md +382 -0
- package/bundle/builtin/skill-creator/scripts/init_skill.cjs +239 -0
- package/bundle/builtin/skill-creator/scripts/package_skill.cjs +131 -0
- package/bundle/builtin/skill-creator/scripts/validate_skill.cjs +131 -0
- package/bundle/docs/CONTRIBUTING.md +1 -0
- package/bundle/docs/admin/enterprise-controls.md +115 -0
- package/bundle/docs/assets/connected_devtools.png +0 -0
- package/bundle/docs/assets/gemini-screenshot.png +0 -0
- package/bundle/docs/assets/monitoring-dashboard-logs.png +0 -0
- package/bundle/docs/assets/monitoring-dashboard-metrics.png +0 -0
- package/bundle/docs/assets/monitoring-dashboard-overview.png +0 -0
- package/bundle/docs/assets/release_patch.png +0 -0
- package/bundle/docs/assets/theme-ansi-light.png +0 -0
- package/bundle/docs/assets/theme-ansi.png +0 -0
- package/bundle/docs/assets/theme-atom-one.png +0 -0
- package/bundle/docs/assets/theme-ayu-light.png +0 -0
- package/bundle/docs/assets/theme-ayu.png +0 -0
- package/bundle/docs/assets/theme-custom.png +0 -0
- package/bundle/docs/assets/theme-default-light.png +0 -0
- package/bundle/docs/assets/theme-default.png +0 -0
- package/bundle/docs/assets/theme-dracula.png +0 -0
- package/bundle/docs/assets/theme-github-light.png +0 -0
- package/bundle/docs/assets/theme-github.png +0 -0
- package/bundle/docs/assets/theme-google-light.png +0 -0
- package/bundle/docs/assets/theme-xcode-light.png +0 -0
- package/bundle/docs/changelogs/index.md +867 -0
- package/bundle/docs/changelogs/latest.md +208 -0
- package/bundle/docs/changelogs/preview.md +187 -0
- package/bundle/docs/cli/checkpointing.md +93 -0
- package/bundle/docs/cli/cli-reference.md +115 -0
- package/bundle/docs/cli/creating-skills.md +80 -0
- package/bundle/docs/cli/custom-commands.md +327 -0
- package/bundle/docs/cli/enterprise.md +604 -0
- package/bundle/docs/cli/gemini-ignore.md +71 -0
- package/bundle/docs/cli/gemini-md.md +116 -0
- package/bundle/docs/cli/generation-settings.md +210 -0
- package/bundle/docs/cli/headless.md +50 -0
- package/bundle/docs/cli/model-routing.md +42 -0
- package/bundle/docs/cli/model.md +53 -0
- package/bundle/docs/cli/plan-mode.md +375 -0
- package/bundle/docs/cli/rewind.md +51 -0
- package/bundle/docs/cli/sandbox.md +257 -0
- package/bundle/docs/cli/session-management.md +184 -0
- package/bundle/docs/cli/settings.md +165 -0
- package/bundle/docs/cli/skills.md +134 -0
- package/bundle/docs/cli/system-prompt.md +125 -0
- package/bundle/docs/cli/telemetry.md +922 -0
- package/bundle/docs/cli/themes.md +269 -0
- package/bundle/docs/cli/token-caching.md +20 -0
- package/bundle/docs/cli/trusted-folders.md +126 -0
- package/bundle/docs/cli/tutorials/automation.md +283 -0
- package/bundle/docs/cli/tutorials/file-management.md +142 -0
- package/bundle/docs/cli/tutorials/mcp-setup.md +113 -0
- package/bundle/docs/cli/tutorials/memory-management.md +126 -0
- package/bundle/docs/cli/tutorials/session-management.md +105 -0
- package/bundle/docs/cli/tutorials/shell-commands.md +107 -0
- package/bundle/docs/cli/tutorials/skills-getting-started.md +110 -0
- package/bundle/docs/cli/tutorials/task-planning.md +93 -0
- package/bundle/docs/cli/tutorials/web-tools.md +78 -0
- package/bundle/docs/core/index.md +107 -0
- package/bundle/docs/core/remote-agents.md +84 -0
- package/bundle/docs/core/subagents.md +307 -0
- package/bundle/docs/examples/proxy-script.md +83 -0
- package/bundle/docs/extensions/best-practices.md +188 -0
- package/bundle/docs/extensions/index.md +61 -0
- package/bundle/docs/extensions/reference.md +333 -0
- package/bundle/docs/extensions/releasing.md +154 -0
- package/bundle/docs/extensions/writing-extensions.md +308 -0
- package/bundle/docs/get-started/authentication.md +402 -0
- package/bundle/docs/get-started/examples.md +139 -0
- package/bundle/docs/get-started/gemini-3.md +115 -0
- package/bundle/docs/get-started/index.md +82 -0
- package/bundle/docs/get-started/installation.md +174 -0
- package/bundle/docs/hooks/best-practices.md +709 -0
- package/bundle/docs/hooks/index.md +164 -0
- package/bundle/docs/hooks/reference.md +330 -0
- package/bundle/docs/hooks/writing-hooks.md +474 -0
- package/bundle/docs/ide-integration/ide-companion-spec.md +267 -0
- package/bundle/docs/ide-integration/index.md +224 -0
- package/bundle/docs/index.md +141 -0
- package/bundle/docs/integration-tests.md +211 -0
- package/bundle/docs/issue-and-pr-automation.md +172 -0
- package/bundle/docs/local-development.md +134 -0
- package/bundle/docs/mermaid/context.mmd +103 -0
- package/bundle/docs/mermaid/render-path.mmd +64 -0
- package/bundle/docs/npm.md +62 -0
- package/bundle/docs/redirects.json +20 -0
- package/bundle/docs/reference/commands.md +526 -0
- package/bundle/docs/reference/configuration.md +1786 -0
- package/bundle/docs/reference/keyboard-shortcuts.md +164 -0
- package/bundle/docs/reference/memport.md +246 -0
- package/bundle/docs/reference/policy-engine.md +364 -0
- package/bundle/docs/reference/tools.md +106 -0
- package/bundle/docs/release-confidence.md +164 -0
- package/bundle/docs/releases.md +540 -0
- package/bundle/docs/resources/faq.md +175 -0
- package/bundle/docs/resources/quota-and-pricing.md +165 -0
- package/bundle/docs/resources/tos-privacy.md +102 -0
- package/bundle/docs/resources/troubleshooting.md +176 -0
- package/bundle/docs/resources/uninstall.md +56 -0
- package/bundle/docs/sidebar.json +233 -0
- package/bundle/docs/tools/activate-skill.md +43 -0
- package/bundle/docs/tools/ask-user.md +95 -0
- package/bundle/docs/tools/file-system.md +129 -0
- package/bundle/docs/tools/internal-docs.md +46 -0
- package/bundle/docs/tools/mcp-server.md +1150 -0
- package/bundle/docs/tools/memory.md +35 -0
- package/bundle/docs/tools/planning.md +58 -0
- package/bundle/docs/tools/shell.md +216 -0
- package/bundle/docs/tools/todos.md +35 -0
- package/bundle/docs/tools/web-fetch.md +35 -0
- package/bundle/docs/tools/web-search.md +32 -0
- package/bundle/docs/update/update-guide.md +111 -0
- package/bundle/masha.js +563471 -0
- package/bundle/node_modules/@dgxo/mashadevcli-devtools/dist/client/main.js +89 -0
- package/bundle/node_modules/@dgxo/mashadevcli-devtools/dist/src/_client-assets.d.ts +7 -0
- package/bundle/node_modules/@dgxo/mashadevcli-devtools/dist/src/_client-assets.js +9 -0
- package/bundle/node_modules/@dgxo/mashadevcli-devtools/dist/src/_client-assets.js.map +1 -0
- package/bundle/node_modules/@dgxo/mashadevcli-devtools/dist/src/index.d.ts +48 -0
- package/bundle/node_modules/@dgxo/mashadevcli-devtools/dist/src/index.js +299 -0
- package/bundle/node_modules/@dgxo/mashadevcli-devtools/dist/src/index.js.map +1 -0
- package/bundle/node_modules/@dgxo/mashadevcli-devtools/dist/src/types.d.ts +36 -0
- package/bundle/node_modules/@dgxo/mashadevcli-devtools/dist/src/types.js +7 -0
- package/bundle/node_modules/@dgxo/mashadevcli-devtools/dist/src/types.js.map +1 -0
- package/bundle/node_modules/@dgxo/mashadevcli-devtools/package.json +32 -0
- package/bundle/policies/conseca.toml +6 -0
- package/bundle/policies/discovered.toml +8 -0
- package/bundle/policies/plan.toml +109 -0
- package/bundle/policies/read-only.toml +53 -0
- package/bundle/policies/write.toml +80 -0
- package/bundle/policies/yolo.toml +54 -0
- package/bundle/sandbox-macos-permissive-open.sb +27 -0
- package/bundle/sandbox-macos-permissive-proxied.sb +37 -0
- package/bundle/sandbox-macos-restrictive-open.sb +96 -0
- package/bundle/sandbox-macos-restrictive-proxied.sb +98 -0
- package/bundle/sandbox-macos-strict-open.sb +131 -0
- package/bundle/sandbox-macos-strict-proxied.sb +133 -0
- package/package.json +169 -0
|
@@ -0,0 +1,175 @@
|
|
|
1
|
+
# Frequently asked questions (FAQ)
|
|
2
|
+
|
|
3
|
+
This page provides answers to common questions and solutions to frequent
|
|
4
|
+
problems encountered while using Gemini CLI.
|
|
5
|
+
|
|
6
|
+
## General issues
|
|
7
|
+
|
|
8
|
+
This section addresses common questions about Gemini CLI usage, security, and
|
|
9
|
+
troubleshooting general errors.
|
|
10
|
+
|
|
11
|
+
### Why can't I use third-party software (e.g. Claude Code, OpenClaw, OpenCode) with Gemini CLI?
|
|
12
|
+
|
|
13
|
+
Using third-party software, tools, or services to harvest or piggyback on Gemini
|
|
14
|
+
CLI's OAuth authentication to access our backend services is a direct violation
|
|
15
|
+
of our [applicable terms and policies](tos-privacy.md). Doing so bypasses our
|
|
16
|
+
intended authentication and security structures, and such actions may be grounds
|
|
17
|
+
for immediate suspension or termination of your account. If you would like to
|
|
18
|
+
use a third-party coding agent with Gemini, the supported and secure method is
|
|
19
|
+
to use a Vertex AI or Google AI Studio API key.
|
|
20
|
+
|
|
21
|
+
### Why am I getting an `API error: 429 - Resource exhausted`?
|
|
22
|
+
|
|
23
|
+
This error indicates that you have exceeded your API request limit. The Gemini
|
|
24
|
+
API has rate limits to prevent abuse and ensure fair usage.
|
|
25
|
+
|
|
26
|
+
To resolve this, you can:
|
|
27
|
+
|
|
28
|
+
- **Check your usage:** Review your API usage in the Google AI Studio or your
|
|
29
|
+
Google Cloud project dashboard.
|
|
30
|
+
- **Optimize your prompts:** If you are making many requests in a short period,
|
|
31
|
+
try to batch your prompts or introduce delays between requests.
|
|
32
|
+
- **Request a quota increase:** If you consistently need a higher limit, you can
|
|
33
|
+
request a quota increase from Google.
|
|
34
|
+
|
|
35
|
+
### Why am I getting an `ERR_REQUIRE_ESM` error when running `npm run start`?
|
|
36
|
+
|
|
37
|
+
This error typically occurs in Node.js projects when there is a mismatch between
|
|
38
|
+
CommonJS and ES Modules.
|
|
39
|
+
|
|
40
|
+
This is often due to a misconfiguration in your `package.json` or
|
|
41
|
+
`tsconfig.json`. Ensure that:
|
|
42
|
+
|
|
43
|
+
1. Your `package.json` has `"type": "module"`.
|
|
44
|
+
2. Your `tsconfig.json` has `"module": "NodeNext"` or a compatible setting in
|
|
45
|
+
the `compilerOptions`.
|
|
46
|
+
|
|
47
|
+
If the problem persists, try deleting your `node_modules` directory and
|
|
48
|
+
`package-lock.json` file, and then run `npm install` again.
|
|
49
|
+
|
|
50
|
+
### Why don't I see cached token counts in my stats output?
|
|
51
|
+
|
|
52
|
+
Cached token information is only displayed when cached tokens are being used.
|
|
53
|
+
This feature is available for API key users (Gemini API key or Google Cloud
|
|
54
|
+
Vertex AI) but not for OAuth users (such as Google Personal/Enterprise accounts
|
|
55
|
+
like Google Gmail or Google Workspace, respectively). This is because the Gemini
|
|
56
|
+
Code Assist API does not support cached content creation. You can still view
|
|
57
|
+
your total token usage using the `/stats` command in Gemini CLI.
|
|
58
|
+
|
|
59
|
+
## Installation and updates
|
|
60
|
+
|
|
61
|
+
### How do I update Gemini CLI to the latest version?
|
|
62
|
+
|
|
63
|
+
If you installed it globally via `npm`, update it using the command
|
|
64
|
+
`npm install -g @dgxo/mashadevcli@latest`. If you compiled it from source, pull
|
|
65
|
+
the latest changes from the repository, and then rebuild using the command
|
|
66
|
+
`npm run build`.
|
|
67
|
+
|
|
68
|
+
## Platform-specific issues
|
|
69
|
+
|
|
70
|
+
### Why does the CLI crash on Windows when I run a command like `chmod +x`?
|
|
71
|
+
|
|
72
|
+
Commands like `chmod` are specific to Unix-like operating systems (Linux,
|
|
73
|
+
macOS). They are not available on Windows by default.
|
|
74
|
+
|
|
75
|
+
To resolve this, you can:
|
|
76
|
+
|
|
77
|
+
- **Use Windows-equivalent commands:** Instead of `chmod`, you can use `icacls`
|
|
78
|
+
to modify file permissions on Windows.
|
|
79
|
+
- **Use a compatibility layer:** Tools like Git Bash or Windows Subsystem for
|
|
80
|
+
Linux (WSL) provide a Unix-like environment on Windows where these commands
|
|
81
|
+
will work.
|
|
82
|
+
|
|
83
|
+
## Configuration
|
|
84
|
+
|
|
85
|
+
### How do I configure my `GOOGLE_CLOUD_PROJECT`?
|
|
86
|
+
|
|
87
|
+
You can configure your Google Cloud Project ID using an environment variable.
|
|
88
|
+
|
|
89
|
+
Set the `GOOGLE_CLOUD_PROJECT` environment variable in your shell:
|
|
90
|
+
|
|
91
|
+
**macOS/Linux**
|
|
92
|
+
|
|
93
|
+
```bash
|
|
94
|
+
export GOOGLE_CLOUD_PROJECT="your-project-id"
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
**Windows (PowerShell)**
|
|
98
|
+
|
|
99
|
+
```powershell
|
|
100
|
+
$env:GOOGLE_CLOUD_PROJECT="your-project-id"
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
To make this setting permanent, add this line to your shell's startup file
|
|
104
|
+
(e.g., `~/.bashrc`, `~/.zshrc`).
|
|
105
|
+
|
|
106
|
+
### What is the best way to store my API keys securely?
|
|
107
|
+
|
|
108
|
+
Exposing API keys in scripts or checking them into source control is a security
|
|
109
|
+
risk.
|
|
110
|
+
|
|
111
|
+
To store your API keys securely, you can:
|
|
112
|
+
|
|
113
|
+
- **Use a `.env` file:** Create a `.env` file in your project's `.gemini`
|
|
114
|
+
directory (`.gemini/.env`) and store your keys there. Gemini CLI will
|
|
115
|
+
automatically load these variables.
|
|
116
|
+
- **Use your system's keyring:** For the most secure storage, use your operating
|
|
117
|
+
system's secret management tool (like macOS Keychain, Windows Credential
|
|
118
|
+
Manager, or a secret manager on Linux). You can then have your scripts or
|
|
119
|
+
environment load the key from the secure storage at runtime.
|
|
120
|
+
|
|
121
|
+
### Where are the Gemini CLI configuration and settings files stored?
|
|
122
|
+
|
|
123
|
+
The Gemini CLI configuration is stored in two `settings.json` files:
|
|
124
|
+
|
|
125
|
+
1. In your home directory: `~/.gemini/settings.json`.
|
|
126
|
+
2. In your project's root directory: `./.gemini/settings.json`.
|
|
127
|
+
|
|
128
|
+
Refer to [Gemini CLI Configuration](../reference/configuration.md) for more
|
|
129
|
+
details.
|
|
130
|
+
|
|
131
|
+
## Google AI Pro/Ultra and subscription FAQs
|
|
132
|
+
|
|
133
|
+
### Where can I learn more about my Google AI Pro or Google AI Ultra subscription?
|
|
134
|
+
|
|
135
|
+
To learn more about your Google AI Pro or Google AI Ultra subscription, visit
|
|
136
|
+
**Manage subscription** in your [subscription settings](https://one.google.com).
|
|
137
|
+
|
|
138
|
+
### How do I know if I have higher limits for Google AI Pro or Ultra?
|
|
139
|
+
|
|
140
|
+
If you're subscribed to Google AI Pro or Ultra, you automatically have higher
|
|
141
|
+
limits to Gemini Code Assist and Gemini CLI. These are shared across Gemini CLI
|
|
142
|
+
and agent mode in the IDE. You can confirm you have higher limits by checking if
|
|
143
|
+
you are still subscribed to Google AI Pro or Ultra in your
|
|
144
|
+
[subscription settings](https://one.google.com).
|
|
145
|
+
|
|
146
|
+
### What is the privacy policy for using Gemini Code Assist or Gemini CLI if I've subscribed to Google AI Pro or Ultra?
|
|
147
|
+
|
|
148
|
+
To learn more about your privacy policy and terms of service governed by your
|
|
149
|
+
subscription, visit
|
|
150
|
+
[Gemini Code Assist: Terms of Service and Privacy Policies](https://developers.google.com/gemini-code-assist/resources/privacy-notices).
|
|
151
|
+
|
|
152
|
+
### I've upgraded to Google AI Pro or Ultra but it still says I am hitting quota limits. Is this a bug?
|
|
153
|
+
|
|
154
|
+
The higher limits in your Google AI Pro or Ultra subscription are for Gemini 2.5
|
|
155
|
+
across both Gemini 2.5 Pro and Flash. They are shared quota across Gemini CLI
|
|
156
|
+
and agent mode in Gemini Code Assist IDE extensions. You can learn more about
|
|
157
|
+
quota limits for Gemini CLI, Gemini Code Assist and agent mode in Gemini Code
|
|
158
|
+
Assist at
|
|
159
|
+
[Quotas and limits](https://developers.google.com/gemini-code-assist/resources/quotas).
|
|
160
|
+
|
|
161
|
+
### If I upgrade to higher limits for Gemini CLI and Gemini Code Assist by purchasing a Google AI Pro or Ultra subscription, will Gemini start using my data to improve its machine learning models?
|
|
162
|
+
|
|
163
|
+
Google does not use your data to improve Google's machine learning models if you
|
|
164
|
+
purchase a paid plan. Note: If you decide to remain on the free version of
|
|
165
|
+
Gemini Code Assist, Gemini Code Assist for individuals, you can also opt out of
|
|
166
|
+
using your data to improve Google's machine learning models. See the
|
|
167
|
+
[Gemini Code Assist for individuals privacy notice](https://developers.google.com/gemini-code-assist/resources/privacy-notice-gemini-code-assist-individuals)
|
|
168
|
+
for more information.
|
|
169
|
+
|
|
170
|
+
## Not seeing your question?
|
|
171
|
+
|
|
172
|
+
Search the
|
|
173
|
+
[Gemini CLI Q&A discussions on GitHub](https://github.com/DGameGT/mashadev-cli/discussions/categories/q-a)
|
|
174
|
+
or
|
|
175
|
+
[start a new discussion on GitHub](https://github.com/DGameGT/mashadev-cli/discussions/new?category=q-a)
|
|
@@ -0,0 +1,165 @@
|
|
|
1
|
+
# Gemini CLI: Quotas and pricing
|
|
2
|
+
|
|
3
|
+
Gemini CLI offers a generous free tier that covers many individual developers'
|
|
4
|
+
use cases. For enterprise or professional usage, or if you need higher limits,
|
|
5
|
+
several options are available depending on your authentication account type.
|
|
6
|
+
|
|
7
|
+
See [privacy and terms](./tos-privacy.md) for details on the Privacy Policy and
|
|
8
|
+
Terms of Service.
|
|
9
|
+
|
|
10
|
+
> **Note:** Published prices are list price; additional negotiated commercial
|
|
11
|
+
> discounting may apply.
|
|
12
|
+
|
|
13
|
+
This article outlines the specific quotas and pricing applicable to Gemini CLI
|
|
14
|
+
when using different authentication methods.
|
|
15
|
+
|
|
16
|
+
Generally, there are three categories to choose from:
|
|
17
|
+
|
|
18
|
+
- Free Usage: Ideal for experimentation and light use.
|
|
19
|
+
- Paid Tier (fixed price): For individual developers or enterprises who need
|
|
20
|
+
more generous daily quotas and predictable costs.
|
|
21
|
+
- Pay-As-You-Go: The most flexible option for professional use, long-running
|
|
22
|
+
tasks, or when you need full control over your usage.
|
|
23
|
+
|
|
24
|
+
## Free usage
|
|
25
|
+
|
|
26
|
+
Your journey begins with a generous free tier, perfect for experimentation and
|
|
27
|
+
light use.
|
|
28
|
+
|
|
29
|
+
Your free usage limits depend on your authorization type.
|
|
30
|
+
|
|
31
|
+
### Log in with Google (Gemini Code Assist for individuals)
|
|
32
|
+
|
|
33
|
+
For users who authenticate by using their Google account to access Gemini Code
|
|
34
|
+
Assist for individuals. This includes:
|
|
35
|
+
|
|
36
|
+
- 1000 model requests / user / day
|
|
37
|
+
- 60 model requests / user / minute
|
|
38
|
+
- Model requests will be made across the Gemini model family as determined by
|
|
39
|
+
Gemini CLI.
|
|
40
|
+
|
|
41
|
+
Learn more at
|
|
42
|
+
[Gemini Code Assist for Individuals Limits](https://developers.google.com/gemini-code-assist/resources/quotas#quotas-for-agent-mode-gemini-cli).
|
|
43
|
+
|
|
44
|
+
### Log in with Gemini API Key (unpaid)
|
|
45
|
+
|
|
46
|
+
If you are using a Gemini API key, you can also benefit from a free tier. This
|
|
47
|
+
includes:
|
|
48
|
+
|
|
49
|
+
- 250 model requests / user / day
|
|
50
|
+
- 10 model requests / user / minute
|
|
51
|
+
- Model requests to Flash model only.
|
|
52
|
+
|
|
53
|
+
Learn more at
|
|
54
|
+
[Gemini API Rate Limits](https://ai.google.dev/gemini-api/docs/rate-limits).
|
|
55
|
+
|
|
56
|
+
### Log in with Vertex AI (Express Mode)
|
|
57
|
+
|
|
58
|
+
Vertex AI offers an Express Mode without the need to enable billing. This
|
|
59
|
+
includes:
|
|
60
|
+
|
|
61
|
+
- 90 days before you need to enable billing.
|
|
62
|
+
- Quotas and models are variable and specific to your account.
|
|
63
|
+
|
|
64
|
+
Learn more at
|
|
65
|
+
[Vertex AI Express Mode Limits](https://cloud.google.com/vertex-ai/generative-ai/docs/start/express-mode/overview#quotas).
|
|
66
|
+
|
|
67
|
+
## Paid tier: Higher limits for a fixed cost
|
|
68
|
+
|
|
69
|
+
If you use up your initial number of requests, you can continue to benefit from
|
|
70
|
+
Gemini CLI by upgrading to one of the following subscriptions:
|
|
71
|
+
|
|
72
|
+
- [Google AI Pro and AI Ultra](https://gemini.google/subscriptions/). This is
|
|
73
|
+
recommended for individual developers. Quotas and pricing are based on a fixed
|
|
74
|
+
price subscription.
|
|
75
|
+
|
|
76
|
+
For predictable costs, you can log in with Google.
|
|
77
|
+
|
|
78
|
+
Learn more at
|
|
79
|
+
[Gemini Code Assist Quotas and Limits](https://developers.google.com/gemini-code-assist/resources/quotas)
|
|
80
|
+
|
|
81
|
+
- [Purchase a Gemini Code Assist Subscription through Google Cloud ](https://cloud.google.com/gemini/docs/codeassist/overview)
|
|
82
|
+
by signing up in the Google Cloud console. Learn more at
|
|
83
|
+
[Set up Gemini Code Assist](https://cloud.google.com/gemini/docs/discover/set-up-gemini).
|
|
84
|
+
|
|
85
|
+
Quotas and pricing are based on a fixed price subscription with assigned
|
|
86
|
+
license seats. For predictable costs, you can sign in with Google.
|
|
87
|
+
|
|
88
|
+
This includes:
|
|
89
|
+
- Gemini Code Assist Standard edition:
|
|
90
|
+
- 1500 model requests / user / day
|
|
91
|
+
- 120 model requests / user / minute
|
|
92
|
+
- Gemini Code Assist Enterprise edition:
|
|
93
|
+
- 2000 model requests / user / day
|
|
94
|
+
- 120 model requests / user / minute
|
|
95
|
+
- Model requests will be made across the Gemini model family as determined by
|
|
96
|
+
Gemini CLI.
|
|
97
|
+
|
|
98
|
+
[Learn more about Gemini Code Assist Standard and Enterprise license limits](https://developers.google.com/gemini-code-assist/resources/quotas#quotas-for-agent-mode-gemini-cli).
|
|
99
|
+
|
|
100
|
+
## Pay as you go
|
|
101
|
+
|
|
102
|
+
If you hit your daily request limits or exhaust your Gemini Pro quota even after
|
|
103
|
+
upgrading, the most flexible solution is to switch to a pay-as-you-go model,
|
|
104
|
+
where you pay for the specific amount of processing you use. This is the
|
|
105
|
+
recommended path for uninterrupted access.
|
|
106
|
+
|
|
107
|
+
To do this, log in using a Gemini API key or Vertex AI.
|
|
108
|
+
|
|
109
|
+
- Vertex AI (Regular Mode):
|
|
110
|
+
- Quota: Governed by a dynamic shared quota system or pre-purchased
|
|
111
|
+
provisioned throughput.
|
|
112
|
+
- Cost: Based on model and token usage.
|
|
113
|
+
|
|
114
|
+
Learn more at
|
|
115
|
+
[Vertex AI Dynamic Shared Quota](https://cloud.google.com/vertex-ai/generative-ai/docs/resources/dynamic-shared-quota)
|
|
116
|
+
and [Vertex AI Pricing](https://cloud.google.com/vertex-ai/pricing).
|
|
117
|
+
|
|
118
|
+
- Gemini API key:
|
|
119
|
+
- Quota: Varies by pricing tier.
|
|
120
|
+
- Cost: Varies by pricing tier and model/token usage.
|
|
121
|
+
|
|
122
|
+
Learn more at
|
|
123
|
+
[Gemini API Rate Limits](https://ai.google.dev/gemini-api/docs/rate-limits),
|
|
124
|
+
[Gemini API Pricing](https://ai.google.dev/gemini-api/docs/pricing)
|
|
125
|
+
|
|
126
|
+
It’s important to highlight that when using an API key, you pay per token/call.
|
|
127
|
+
This can be more expensive for many small calls with few tokens, but it's the
|
|
128
|
+
only way to ensure your workflow isn't interrupted by quota limits.
|
|
129
|
+
|
|
130
|
+
## Gemini for workspace plans
|
|
131
|
+
|
|
132
|
+
These plans currently apply only to the use of Gemini web-based products
|
|
133
|
+
provided by Google-based experiences (for example, the Gemini web app or the
|
|
134
|
+
Flow video editor). These plans do not apply to the API usage which powers the
|
|
135
|
+
Gemini CLI. Supporting these plans is under active consideration for future
|
|
136
|
+
support.
|
|
137
|
+
|
|
138
|
+
## Check usage and quota
|
|
139
|
+
|
|
140
|
+
You can check your current token usage and quota information using the
|
|
141
|
+
`/stats model` command. This command provides a snapshot of your current
|
|
142
|
+
session's token usage, as well as your overall quota and usage for the supported
|
|
143
|
+
models.
|
|
144
|
+
|
|
145
|
+
For more information on the `/stats` command and its subcommands, see the
|
|
146
|
+
[Command Reference](../../reference/commands.md#stats).
|
|
147
|
+
|
|
148
|
+
A summary of model usage is also presented on exit at the end of a session.
|
|
149
|
+
|
|
150
|
+
## Tips to avoid high costs
|
|
151
|
+
|
|
152
|
+
When using a Pay as you Go API key, be mindful of your usage to avoid unexpected
|
|
153
|
+
costs.
|
|
154
|
+
|
|
155
|
+
- Don't blindly accept every suggestion, especially for computationally
|
|
156
|
+
intensive tasks like refactoring large codebases.
|
|
157
|
+
- Be intentional with your prompts and commands. You are paying per call, so
|
|
158
|
+
think about the most efficient way to get the job done.
|
|
159
|
+
|
|
160
|
+
## Gemini API vs. Vertex
|
|
161
|
+
|
|
162
|
+
- Gemini API (gemini developer api): This is the fastest way to use the Gemini
|
|
163
|
+
models directly.
|
|
164
|
+
- Vertex AI: This is the enterprise-grade platform for building, deploying, and
|
|
165
|
+
managing Gemini models with specific security and control requirements.
|
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
# Gemini CLI: License, Terms of Service, and Privacy Notices
|
|
2
|
+
|
|
3
|
+
Gemini CLI is an open-source tool that lets you interact with Google's powerful
|
|
4
|
+
AI services directly from your command-line interface. The Gemini CLI software
|
|
5
|
+
is licensed under the
|
|
6
|
+
[Apache 2.0 license](https://github.com/DGameGT/mashadev-cli/blob/main/LICENSE).
|
|
7
|
+
When you use Gemini CLI to access or use Google’s services, the Terms of Service
|
|
8
|
+
and Privacy Notices applicable to those services apply to such access and use.
|
|
9
|
+
|
|
10
|
+
Directly accessing the services powering Gemini CLI (e.g., the Gemini Code
|
|
11
|
+
Assist service) using third-party software, tools, or services (for example,
|
|
12
|
+
using OpenClaw with Gemini CLI OAuth) is a violation of applicable terms and
|
|
13
|
+
policies. Such actions may be grounds for suspension or termination of your
|
|
14
|
+
account.
|
|
15
|
+
|
|
16
|
+
Your Gemini CLI Usage Statistics are handled in accordance with Google's Privacy
|
|
17
|
+
Policy.
|
|
18
|
+
|
|
19
|
+
**Note:** See [quotas and pricing](/docs/resources/quota-and-pricing.md) for the
|
|
20
|
+
quota and pricing details that apply to your usage of the Gemini CLI.
|
|
21
|
+
|
|
22
|
+
## Supported authentication methods
|
|
23
|
+
|
|
24
|
+
Your authentication method refers to the method you use to log into and access
|
|
25
|
+
Google’s services with Gemini CLI. Supported authentication methods include:
|
|
26
|
+
|
|
27
|
+
- Logging in with your Google account to Gemini Code Assist.
|
|
28
|
+
- Using an API key with Gemini Developer API.
|
|
29
|
+
- Using an API key with Vertex AI GenAI API.
|
|
30
|
+
|
|
31
|
+
The Terms of Service and Privacy Notices applicable to the aforementioned Google
|
|
32
|
+
services are set forth in the table below.
|
|
33
|
+
|
|
34
|
+
If you log in with your Google account and you do not already have a Gemini Code
|
|
35
|
+
Assist account associated with your Google account, you will be directed to the
|
|
36
|
+
sign up flow for Gemini Code Assist for individuals. If your Google account is
|
|
37
|
+
managed by your organization, your administrator may not permit access to Gemini
|
|
38
|
+
Code Assist for individuals. Please see the
|
|
39
|
+
[Gemini Code Assist for individuals FAQs](https://developers.google.com/gemini-code-assist/resources/faqs)
|
|
40
|
+
for further information.
|
|
41
|
+
|
|
42
|
+
| Authentication Method | Service(s) | Terms of Service | Privacy Notice |
|
|
43
|
+
| :----------------------- | :--------------------------- | :------------------------------------------------------------------------------------------------------ | :-------------------------------------------------------------------------------------------- |
|
|
44
|
+
| Google Account | Gemini Code Assist services | [Terms of Service](https://developers.google.com/gemini-code-assist/resources/privacy-notices) | [Privacy Notices](https://developers.google.com/gemini-code-assist/resources/privacy-notices) |
|
|
45
|
+
| Gemini Developer API Key | Gemini API - Unpaid Services | [Gemini API Terms of Service - Unpaid Services](https://ai.google.dev/gemini-api/terms#unpaid-services) | [Google Privacy Policy](https://policies.google.com/privacy) |
|
|
46
|
+
| Gemini Developer API Key | Gemini API - Paid Services | [Gemini API Terms of Service - Paid Services](https://ai.google.dev/gemini-api/terms#paid-services) | [Google Privacy Policy](https://policies.google.com/privacy) |
|
|
47
|
+
| Vertex AI GenAI API Key | Vertex AI GenAI API | [Google Cloud Platform Terms of Service](https://cloud.google.com/terms/service-terms/) | [Google Cloud Privacy Notice](https://cloud.google.com/terms/cloud-privacy-notice) |
|
|
48
|
+
|
|
49
|
+
## 1. If you have logged in with your Google account to Gemini Code Assist
|
|
50
|
+
|
|
51
|
+
For users who use their Google account to access
|
|
52
|
+
[Gemini Code Assist](https://codeassist.google), these Terms of Service and
|
|
53
|
+
Privacy Notice documents apply:
|
|
54
|
+
|
|
55
|
+
- Gemini Code Assist for individuals:
|
|
56
|
+
[Google Terms of Service](https://policies.google.com/terms) and
|
|
57
|
+
[Gemini Code Assist for individuals Privacy Notice](https://developers.google.com/gemini-code-assist/resources/privacy-notice-gemini-code-assist-individuals).
|
|
58
|
+
- Gemini Code Assist with Google AI Pro or Ultra subscription:
|
|
59
|
+
[Google Terms of Service](https://policies.google.com/terms),
|
|
60
|
+
[Google One Additional Terms of Service](https://one.google.com/terms-of-service)
|
|
61
|
+
and [Google Privacy Policy\*](https://policies.google.com/privacy).
|
|
62
|
+
- Gemini Code Assist Standard and Enterprise editions:
|
|
63
|
+
[Google Cloud Platform Terms of Service](https://cloud.google.com/terms) and
|
|
64
|
+
[Google Cloud Privacy Notice](https://cloud.google.com/terms/cloud-privacy-notice).
|
|
65
|
+
|
|
66
|
+
_\* If your account is also associated with an active subscription to Gemini
|
|
67
|
+
Code Assist Standard or Enterprise edition, the terms and privacy policy of
|
|
68
|
+
Gemini Code Assist Standard or Enterprise edition will apply to all your use of
|
|
69
|
+
Gemini Code Assist._
|
|
70
|
+
|
|
71
|
+
## 2. If you have logged in with a Gemini API key to the Gemini Developer API
|
|
72
|
+
|
|
73
|
+
If you are using a Gemini API key for authentication with the
|
|
74
|
+
[Gemini Developer API](https://ai.google.dev/gemini-api/docs), these Terms of
|
|
75
|
+
Service and Privacy Notice documents apply:
|
|
76
|
+
|
|
77
|
+
- Terms of Service: Your use of the Gemini CLI is governed by the
|
|
78
|
+
[Gemini API Terms of Service](https://ai.google.dev/gemini-api/terms). These
|
|
79
|
+
terms may differ depending on whether you are using an unpaid or paid service:
|
|
80
|
+
- For unpaid services, refer to the
|
|
81
|
+
[Gemini API Terms of Service - Unpaid Services](https://ai.google.dev/gemini-api/terms#unpaid-services).
|
|
82
|
+
- For paid services, refer to the
|
|
83
|
+
[Gemini API Terms of Service - Paid Services](https://ai.google.dev/gemini-api/terms#paid-services).
|
|
84
|
+
- Privacy Notice: The collection and use of your data is described in the
|
|
85
|
+
[Google Privacy Policy](https://policies.google.com/privacy).
|
|
86
|
+
|
|
87
|
+
## 3. If you have logged in with a Gemini API key to the Vertex AI GenAI API
|
|
88
|
+
|
|
89
|
+
If you are using a Gemini API key for authentication with a
|
|
90
|
+
[Vertex AI GenAI API](https://cloud.google.com/vertex-ai/generative-ai/docs/reference/rest)
|
|
91
|
+
backend, these Terms of Service and Privacy Notice documents apply:
|
|
92
|
+
|
|
93
|
+
- Terms of Service: Your use of the Gemini CLI is governed by the
|
|
94
|
+
[Google Cloud Platform Service Terms](https://cloud.google.com/terms/service-terms/).
|
|
95
|
+
- Privacy Notice: The collection and use of your data is described in the
|
|
96
|
+
[Google Cloud Privacy Notice](https://cloud.google.com/terms/cloud-privacy-notice).
|
|
97
|
+
|
|
98
|
+
## Usage statistics opt-out
|
|
99
|
+
|
|
100
|
+
You may opt-out from sending Gemini CLI Usage Statistics to Google by following
|
|
101
|
+
the instructions available here:
|
|
102
|
+
[Usage Statistics Configuration](https://github.com/DGameGT/mashadev-cli/blob/main/docs/reference/configuration.md#usage-statistics).
|
|
@@ -0,0 +1,176 @@
|
|
|
1
|
+
# Troubleshooting guide
|
|
2
|
+
|
|
3
|
+
This guide provides solutions to common issues and debugging tips, including
|
|
4
|
+
topics on:
|
|
5
|
+
|
|
6
|
+
- Authentication or login errors
|
|
7
|
+
- Frequently asked questions (FAQs)
|
|
8
|
+
- Debugging tips
|
|
9
|
+
- Existing GitHub Issues similar to yours or creating new Issues
|
|
10
|
+
|
|
11
|
+
## Authentication or login errors
|
|
12
|
+
|
|
13
|
+
- **Error:
|
|
14
|
+
`You must be a named user on your organization's Gemini Code Assist Standard edition subscription to use this service. Please contact your administrator to request an entitlement to Gemini Code Assist Standard edition.`**
|
|
15
|
+
- **Cause:** This error might occur if Gemini CLI detects the
|
|
16
|
+
`GOOGLE_CLOUD_PROJECT` or `GOOGLE_CLOUD_PROJECT_ID` environment variable is
|
|
17
|
+
defined. Setting these variables forces an organization subscription check.
|
|
18
|
+
This might be an issue if you are using an individual Google account not
|
|
19
|
+
linked to an organizational subscription.
|
|
20
|
+
|
|
21
|
+
- **Solution:**
|
|
22
|
+
- **Individual Users:** Unset the `GOOGLE_CLOUD_PROJECT` and
|
|
23
|
+
`GOOGLE_CLOUD_PROJECT_ID` environment variables. Check and remove these
|
|
24
|
+
variables from your shell configuration files (for example, `.bashrc`,
|
|
25
|
+
`.zshrc`) and any `.env` files. If this doesn't resolve the issue, try
|
|
26
|
+
using a different Google account.
|
|
27
|
+
|
|
28
|
+
- **Organizational Users:** Contact your Google Cloud administrator to be
|
|
29
|
+
added to your organization's Gemini Code Assist subscription.
|
|
30
|
+
|
|
31
|
+
- **Error:
|
|
32
|
+
`Failed to login. Message: Your current account is not eligible... because it is not currently available in your location.`**
|
|
33
|
+
- **Cause:** Gemini CLI does not currently support your location. For a full
|
|
34
|
+
list of supported locations, see the following pages:
|
|
35
|
+
- Gemini Code Assist for individuals:
|
|
36
|
+
[Available locations](https://developers.google.com/gemini-code-assist/resources/available-locations#americas)
|
|
37
|
+
|
|
38
|
+
- **Error: `Failed to login. Message: Request contains an invalid argument`**
|
|
39
|
+
- **Cause:** Users with Google Workspace accounts or Google Cloud accounts
|
|
40
|
+
associated with their Gmail accounts may not be able to activate the free
|
|
41
|
+
tier of the Google Code Assist plan.
|
|
42
|
+
- **Solution:** For Google Cloud accounts, you can work around this by setting
|
|
43
|
+
`GOOGLE_CLOUD_PROJECT` to your project ID. Alternatively, you can obtain the
|
|
44
|
+
Gemini API key from
|
|
45
|
+
[Google AI Studio](http://aistudio.google.com/app/apikey), which also
|
|
46
|
+
includes a separate free tier.
|
|
47
|
+
|
|
48
|
+
- **Error: `UNABLE_TO_GET_ISSUER_CERT_LOCALLY` or
|
|
49
|
+
`unable to get local issuer certificate`**
|
|
50
|
+
- **Cause:** You may be on a corporate network with a firewall that intercepts
|
|
51
|
+
and inspects SSL/TLS traffic. This often requires a custom root CA
|
|
52
|
+
certificate to be trusted by Node.js.
|
|
53
|
+
- **Solution:** First try setting `NODE_USE_SYSTEM_CA`; if that does not
|
|
54
|
+
resolve the issue, set `NODE_EXTRA_CA_CERTS`.
|
|
55
|
+
- Set the `NODE_USE_SYSTEM_CA=1` environment variable to tell Node.js to use
|
|
56
|
+
the operating system's native certificate store (where corporate
|
|
57
|
+
certificates are typically already installed).
|
|
58
|
+
- Example: `export NODE_USE_SYSTEM_CA=1` (Windows PowerShell:
|
|
59
|
+
`$env:NODE_USE_SYSTEM_CA=1`)
|
|
60
|
+
- Set the `NODE_EXTRA_CA_CERTS` environment variable to the absolute path of
|
|
61
|
+
your corporate root CA certificate file.
|
|
62
|
+
- Example: `export NODE_EXTRA_CA_CERTS=/path/to/your/corporate-ca.crt`
|
|
63
|
+
(Windows PowerShell:
|
|
64
|
+
`$env:NODE_EXTRA_CA_CERTS="C:\path\to\your\corporate-ca.crt"`)
|
|
65
|
+
|
|
66
|
+
## Common error messages and solutions
|
|
67
|
+
|
|
68
|
+
- **Error: `EADDRINUSE` (Address already in use) when starting an MCP server.**
|
|
69
|
+
- **Cause:** Another process is already using the port that the MCP server is
|
|
70
|
+
trying to bind to.
|
|
71
|
+
- **Solution:** Either stop the other process that is using the port or
|
|
72
|
+
configure the MCP server to use a different port.
|
|
73
|
+
|
|
74
|
+
- **Error: Command not found (when attempting to run Gemini CLI with
|
|
75
|
+
`gemini`).**
|
|
76
|
+
- **Cause:** Gemini CLI is not correctly installed or it is not in your
|
|
77
|
+
system's `PATH`.
|
|
78
|
+
- **Solution:** The update depends on how you installed Gemini CLI:
|
|
79
|
+
- If you installed `gemini` globally, check that your `npm` global binary
|
|
80
|
+
directory is in your `PATH`. You can update Gemini CLI using the command
|
|
81
|
+
`npm install -g @dgxo/mashadevcli@latest`.
|
|
82
|
+
- If you are running `gemini` from source, ensure you are using the correct
|
|
83
|
+
command to invoke it (e.g., `node packages/cli/dist/index.js ...`). To
|
|
84
|
+
update Gemini CLI, pull the latest changes from the repository, and then
|
|
85
|
+
rebuild using the command `npm run build`.
|
|
86
|
+
|
|
87
|
+
- **Error: `MODULE_NOT_FOUND` or import errors.**
|
|
88
|
+
- **Cause:** Dependencies are not installed correctly, or the project hasn't
|
|
89
|
+
been built.
|
|
90
|
+
- **Solution:**
|
|
91
|
+
1. Run `npm install` to ensure all dependencies are present.
|
|
92
|
+
2. Run `npm run build` to compile the project.
|
|
93
|
+
3. Verify that the build completed successfully with `npm run start`.
|
|
94
|
+
|
|
95
|
+
- **Error: "Operation not permitted", "Permission denied", or similar.**
|
|
96
|
+
- **Cause:** When sandboxing is enabled, Gemini CLI may attempt operations
|
|
97
|
+
that are restricted by your sandbox configuration, such as writing outside
|
|
98
|
+
the project directory or system temp directory.
|
|
99
|
+
- **Solution:** Refer to the [Configuration: Sandboxing](../cli/sandbox.md)
|
|
100
|
+
documentation for more information, including how to customize your sandbox
|
|
101
|
+
configuration.
|
|
102
|
+
|
|
103
|
+
- **Gemini CLI is not running in interactive mode in "CI" environments**
|
|
104
|
+
- **Issue:** The Gemini CLI does not enter interactive mode (no prompt
|
|
105
|
+
appears) if an environment variable starting with `CI_` (e.g., `CI_TOKEN`)
|
|
106
|
+
is set. This is because the `is-in-ci` package, used by the underlying UI
|
|
107
|
+
framework, detects these variables and assumes a non-interactive CI
|
|
108
|
+
environment.
|
|
109
|
+
- **Cause:** The `is-in-ci` package checks for the presence of `CI`,
|
|
110
|
+
`CONTINUOUS_INTEGRATION`, or any environment variable with a `CI_` prefix.
|
|
111
|
+
When any of these are found, it signals that the environment is
|
|
112
|
+
non-interactive, which prevents the Gemini CLI from starting in its
|
|
113
|
+
interactive mode.
|
|
114
|
+
- **Solution:** If the `CI_` prefixed variable is not needed for the CLI to
|
|
115
|
+
function, you can temporarily unset it for the command. e.g.,
|
|
116
|
+
`env -u CI_TOKEN gemini`
|
|
117
|
+
|
|
118
|
+
- **DEBUG mode not working from project .env file**
|
|
119
|
+
- **Issue:** Setting `DEBUG=true` in a project's `.env` file doesn't enable
|
|
120
|
+
debug mode for gemini-cli.
|
|
121
|
+
- **Cause:** The `DEBUG` and `DEBUG_MODE` variables are automatically excluded
|
|
122
|
+
from project `.env` files to prevent interference with gemini-cli behavior.
|
|
123
|
+
- **Solution:** Use a `.gemini/.env` file instead, or configure the
|
|
124
|
+
`advanced.excludedEnvVars` setting in your `settings.json` to exclude fewer
|
|
125
|
+
variables.
|
|
126
|
+
|
|
127
|
+
## Exit codes
|
|
128
|
+
|
|
129
|
+
The Gemini CLI uses specific exit codes to indicate the reason for termination.
|
|
130
|
+
This is especially useful for scripting and automation.
|
|
131
|
+
|
|
132
|
+
| Exit Code | Error Type | Description |
|
|
133
|
+
| --------- | -------------------------- | --------------------------------------------------------------------------------------------------- |
|
|
134
|
+
| 41 | `FatalAuthenticationError` | An error occurred during the authentication process. |
|
|
135
|
+
| 42 | `FatalInputError` | Invalid or missing input was provided to the CLI. (non-interactive mode only) |
|
|
136
|
+
| 44 | `FatalSandboxError` | An error occurred with the sandboxing environment (e.g., Docker, Podman, or Seatbelt). |
|
|
137
|
+
| 52 | `FatalConfigError` | A configuration file (`settings.json`) is invalid or contains errors. |
|
|
138
|
+
| 53 | `FatalTurnLimitedError` | The maximum number of conversational turns for the session was reached. (non-interactive mode only) |
|
|
139
|
+
|
|
140
|
+
## Debugging tips
|
|
141
|
+
|
|
142
|
+
- **CLI debugging:**
|
|
143
|
+
- Use the `--debug` flag for more detailed output. In interactive mode, press
|
|
144
|
+
F12 to view the debug console.
|
|
145
|
+
- Check the CLI logs, often found in a user-specific configuration or cache
|
|
146
|
+
directory.
|
|
147
|
+
|
|
148
|
+
- **Core debugging:**
|
|
149
|
+
- Check the server console output for error messages or stack traces.
|
|
150
|
+
- Increase log verbosity if configurable. For example, set the `DEBUG_MODE`
|
|
151
|
+
environment variable to `true` or `1`.
|
|
152
|
+
- Use Node.js debugging tools (e.g., `node --inspect`) if you need to step
|
|
153
|
+
through server-side code.
|
|
154
|
+
|
|
155
|
+
- **Tool issues:**
|
|
156
|
+
- If a specific tool is failing, try to isolate the issue by running the
|
|
157
|
+
simplest possible version of the command or operation the tool performs.
|
|
158
|
+
- For `run_shell_command`, check that the command works directly in your shell
|
|
159
|
+
first.
|
|
160
|
+
- For _file system tools_, verify that paths are correct and check the
|
|
161
|
+
permissions.
|
|
162
|
+
|
|
163
|
+
- **Pre-flight checks:**
|
|
164
|
+
- Always run `npm run preflight` before committing code. This can catch many
|
|
165
|
+
common issues related to formatting, linting, and type errors.
|
|
166
|
+
|
|
167
|
+
## Existing GitHub issues similar to yours or creating new issues
|
|
168
|
+
|
|
169
|
+
If you encounter an issue that was not covered here in this _Troubleshooting
|
|
170
|
+
guide_, consider searching the Gemini CLI
|
|
171
|
+
[Issue tracker on GitHub](https://github.com/DGameGT/mashadev-cli/issues).
|
|
172
|
+
If you can't find an issue similar to yours, consider creating a new GitHub
|
|
173
|
+
Issue with a detailed description. Pull requests are also welcome!
|
|
174
|
+
|
|
175
|
+
> **Note:** Issues tagged as "🔒Maintainers only" are reserved for project
|
|
176
|
+
> maintainers. We will not accept pull requests related to these issues.
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# Uninstalling the CLI
|
|
2
|
+
|
|
3
|
+
Your uninstall method depends on how you ran the CLI. Follow the instructions
|
|
4
|
+
for either npx or a global npm installation.
|
|
5
|
+
|
|
6
|
+
## Method 1: Using npx
|
|
7
|
+
|
|
8
|
+
npx runs packages from a temporary cache without a permanent installation. To
|
|
9
|
+
"uninstall" the CLI, you must clear this cache, which will remove gemini-cli and
|
|
10
|
+
any other packages previously executed with npx.
|
|
11
|
+
|
|
12
|
+
The npx cache is a directory named `_npx` inside your main npm cache folder. You
|
|
13
|
+
can find your npm cache path by running `npm config get cache`.
|
|
14
|
+
|
|
15
|
+
**For macOS / Linux**
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
# The path is typically ~/.npm/_npx
|
|
19
|
+
rm -rf "$(npm config get cache)/_npx"
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
**For Windows (PowerShell)**
|
|
23
|
+
|
|
24
|
+
```powershell
|
|
25
|
+
# The path is typically $env:LocalAppData\npm-cache\_npx
|
|
26
|
+
Remove-Item -Path (Join-Path $env:LocalAppData "npm-cache\_npx") -Recurse -Force
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## Method 2: Using npm (global install)
|
|
30
|
+
|
|
31
|
+
If you installed the CLI globally (e.g., `npm install -g @dgxo/mashadevcli`),
|
|
32
|
+
use the `npm uninstall` command with the `-g` flag to remove it.
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
npm uninstall -g @dgxo/mashadevcli
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
This command completely removes the package from your system.
|
|
39
|
+
|
|
40
|
+
## Method 3: Homebrew
|
|
41
|
+
|
|
42
|
+
If you installed the CLI globally using Homebrew (e.g.,
|
|
43
|
+
`brew install gemini-cli`), use the `brew uninstall` command to remove it.
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
brew uninstall gemini-cli
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
## Method 4: MacPorts
|
|
50
|
+
|
|
51
|
+
If you installed the CLI globally using MacPorts (e.g.,
|
|
52
|
+
`sudo port install gemini-cli`), use the `port uninstall` command to remove it.
|
|
53
|
+
|
|
54
|
+
```bash
|
|
55
|
+
sudo port uninstall gemini-cli
|
|
56
|
+
```
|