@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.
Files changed (140) hide show
  1. package/LICENSE +202 -0
  2. package/README.md +393 -0
  3. package/bundle/builtin/skill-creator/SKILL.md +382 -0
  4. package/bundle/builtin/skill-creator/scripts/init_skill.cjs +239 -0
  5. package/bundle/builtin/skill-creator/scripts/package_skill.cjs +131 -0
  6. package/bundle/builtin/skill-creator/scripts/validate_skill.cjs +131 -0
  7. package/bundle/docs/CONTRIBUTING.md +1 -0
  8. package/bundle/docs/admin/enterprise-controls.md +115 -0
  9. package/bundle/docs/assets/connected_devtools.png +0 -0
  10. package/bundle/docs/assets/gemini-screenshot.png +0 -0
  11. package/bundle/docs/assets/monitoring-dashboard-logs.png +0 -0
  12. package/bundle/docs/assets/monitoring-dashboard-metrics.png +0 -0
  13. package/bundle/docs/assets/monitoring-dashboard-overview.png +0 -0
  14. package/bundle/docs/assets/release_patch.png +0 -0
  15. package/bundle/docs/assets/theme-ansi-light.png +0 -0
  16. package/bundle/docs/assets/theme-ansi.png +0 -0
  17. package/bundle/docs/assets/theme-atom-one.png +0 -0
  18. package/bundle/docs/assets/theme-ayu-light.png +0 -0
  19. package/bundle/docs/assets/theme-ayu.png +0 -0
  20. package/bundle/docs/assets/theme-custom.png +0 -0
  21. package/bundle/docs/assets/theme-default-light.png +0 -0
  22. package/bundle/docs/assets/theme-default.png +0 -0
  23. package/bundle/docs/assets/theme-dracula.png +0 -0
  24. package/bundle/docs/assets/theme-github-light.png +0 -0
  25. package/bundle/docs/assets/theme-github.png +0 -0
  26. package/bundle/docs/assets/theme-google-light.png +0 -0
  27. package/bundle/docs/assets/theme-xcode-light.png +0 -0
  28. package/bundle/docs/changelogs/index.md +867 -0
  29. package/bundle/docs/changelogs/latest.md +208 -0
  30. package/bundle/docs/changelogs/preview.md +187 -0
  31. package/bundle/docs/cli/checkpointing.md +93 -0
  32. package/bundle/docs/cli/cli-reference.md +115 -0
  33. package/bundle/docs/cli/creating-skills.md +80 -0
  34. package/bundle/docs/cli/custom-commands.md +327 -0
  35. package/bundle/docs/cli/enterprise.md +604 -0
  36. package/bundle/docs/cli/gemini-ignore.md +71 -0
  37. package/bundle/docs/cli/gemini-md.md +116 -0
  38. package/bundle/docs/cli/generation-settings.md +210 -0
  39. package/bundle/docs/cli/headless.md +50 -0
  40. package/bundle/docs/cli/model-routing.md +42 -0
  41. package/bundle/docs/cli/model.md +53 -0
  42. package/bundle/docs/cli/plan-mode.md +375 -0
  43. package/bundle/docs/cli/rewind.md +51 -0
  44. package/bundle/docs/cli/sandbox.md +257 -0
  45. package/bundle/docs/cli/session-management.md +184 -0
  46. package/bundle/docs/cli/settings.md +165 -0
  47. package/bundle/docs/cli/skills.md +134 -0
  48. package/bundle/docs/cli/system-prompt.md +125 -0
  49. package/bundle/docs/cli/telemetry.md +922 -0
  50. package/bundle/docs/cli/themes.md +269 -0
  51. package/bundle/docs/cli/token-caching.md +20 -0
  52. package/bundle/docs/cli/trusted-folders.md +126 -0
  53. package/bundle/docs/cli/tutorials/automation.md +283 -0
  54. package/bundle/docs/cli/tutorials/file-management.md +142 -0
  55. package/bundle/docs/cli/tutorials/mcp-setup.md +113 -0
  56. package/bundle/docs/cli/tutorials/memory-management.md +126 -0
  57. package/bundle/docs/cli/tutorials/session-management.md +105 -0
  58. package/bundle/docs/cli/tutorials/shell-commands.md +107 -0
  59. package/bundle/docs/cli/tutorials/skills-getting-started.md +110 -0
  60. package/bundle/docs/cli/tutorials/task-planning.md +93 -0
  61. package/bundle/docs/cli/tutorials/web-tools.md +78 -0
  62. package/bundle/docs/core/index.md +107 -0
  63. package/bundle/docs/core/remote-agents.md +84 -0
  64. package/bundle/docs/core/subagents.md +307 -0
  65. package/bundle/docs/examples/proxy-script.md +83 -0
  66. package/bundle/docs/extensions/best-practices.md +188 -0
  67. package/bundle/docs/extensions/index.md +61 -0
  68. package/bundle/docs/extensions/reference.md +333 -0
  69. package/bundle/docs/extensions/releasing.md +154 -0
  70. package/bundle/docs/extensions/writing-extensions.md +308 -0
  71. package/bundle/docs/get-started/authentication.md +402 -0
  72. package/bundle/docs/get-started/examples.md +139 -0
  73. package/bundle/docs/get-started/gemini-3.md +115 -0
  74. package/bundle/docs/get-started/index.md +82 -0
  75. package/bundle/docs/get-started/installation.md +174 -0
  76. package/bundle/docs/hooks/best-practices.md +709 -0
  77. package/bundle/docs/hooks/index.md +164 -0
  78. package/bundle/docs/hooks/reference.md +330 -0
  79. package/bundle/docs/hooks/writing-hooks.md +474 -0
  80. package/bundle/docs/ide-integration/ide-companion-spec.md +267 -0
  81. package/bundle/docs/ide-integration/index.md +224 -0
  82. package/bundle/docs/index.md +141 -0
  83. package/bundle/docs/integration-tests.md +211 -0
  84. package/bundle/docs/issue-and-pr-automation.md +172 -0
  85. package/bundle/docs/local-development.md +134 -0
  86. package/bundle/docs/mermaid/context.mmd +103 -0
  87. package/bundle/docs/mermaid/render-path.mmd +64 -0
  88. package/bundle/docs/npm.md +62 -0
  89. package/bundle/docs/redirects.json +20 -0
  90. package/bundle/docs/reference/commands.md +526 -0
  91. package/bundle/docs/reference/configuration.md +1786 -0
  92. package/bundle/docs/reference/keyboard-shortcuts.md +164 -0
  93. package/bundle/docs/reference/memport.md +246 -0
  94. package/bundle/docs/reference/policy-engine.md +364 -0
  95. package/bundle/docs/reference/tools.md +106 -0
  96. package/bundle/docs/release-confidence.md +164 -0
  97. package/bundle/docs/releases.md +540 -0
  98. package/bundle/docs/resources/faq.md +175 -0
  99. package/bundle/docs/resources/quota-and-pricing.md +165 -0
  100. package/bundle/docs/resources/tos-privacy.md +102 -0
  101. package/bundle/docs/resources/troubleshooting.md +176 -0
  102. package/bundle/docs/resources/uninstall.md +56 -0
  103. package/bundle/docs/sidebar.json +233 -0
  104. package/bundle/docs/tools/activate-skill.md +43 -0
  105. package/bundle/docs/tools/ask-user.md +95 -0
  106. package/bundle/docs/tools/file-system.md +129 -0
  107. package/bundle/docs/tools/internal-docs.md +46 -0
  108. package/bundle/docs/tools/mcp-server.md +1150 -0
  109. package/bundle/docs/tools/memory.md +35 -0
  110. package/bundle/docs/tools/planning.md +58 -0
  111. package/bundle/docs/tools/shell.md +216 -0
  112. package/bundle/docs/tools/todos.md +35 -0
  113. package/bundle/docs/tools/web-fetch.md +35 -0
  114. package/bundle/docs/tools/web-search.md +32 -0
  115. package/bundle/docs/update/update-guide.md +111 -0
  116. package/bundle/masha.js +563471 -0
  117. package/bundle/node_modules/@dgxo/mashadevcli-devtools/dist/client/main.js +89 -0
  118. package/bundle/node_modules/@dgxo/mashadevcli-devtools/dist/src/_client-assets.d.ts +7 -0
  119. package/bundle/node_modules/@dgxo/mashadevcli-devtools/dist/src/_client-assets.js +9 -0
  120. package/bundle/node_modules/@dgxo/mashadevcli-devtools/dist/src/_client-assets.js.map +1 -0
  121. package/bundle/node_modules/@dgxo/mashadevcli-devtools/dist/src/index.d.ts +48 -0
  122. package/bundle/node_modules/@dgxo/mashadevcli-devtools/dist/src/index.js +299 -0
  123. package/bundle/node_modules/@dgxo/mashadevcli-devtools/dist/src/index.js.map +1 -0
  124. package/bundle/node_modules/@dgxo/mashadevcli-devtools/dist/src/types.d.ts +36 -0
  125. package/bundle/node_modules/@dgxo/mashadevcli-devtools/dist/src/types.js +7 -0
  126. package/bundle/node_modules/@dgxo/mashadevcli-devtools/dist/src/types.js.map +1 -0
  127. package/bundle/node_modules/@dgxo/mashadevcli-devtools/package.json +32 -0
  128. package/bundle/policies/conseca.toml +6 -0
  129. package/bundle/policies/discovered.toml +8 -0
  130. package/bundle/policies/plan.toml +109 -0
  131. package/bundle/policies/read-only.toml +53 -0
  132. package/bundle/policies/write.toml +80 -0
  133. package/bundle/policies/yolo.toml +54 -0
  134. package/bundle/sandbox-macos-permissive-open.sb +27 -0
  135. package/bundle/sandbox-macos-permissive-proxied.sb +37 -0
  136. package/bundle/sandbox-macos-restrictive-open.sb +96 -0
  137. package/bundle/sandbox-macos-restrictive-proxied.sb +98 -0
  138. package/bundle/sandbox-macos-strict-open.sb +131 -0
  139. package/bundle/sandbox-macos-strict-proxied.sb +133 -0
  140. package/package.json +169 -0
@@ -0,0 +1,82 @@
1
+ # Get started with Gemini CLI
2
+
3
+ Welcome to Gemini CLI! This guide will help you install, configure, and start
4
+ using the Gemini CLI to enhance your workflow right from your terminal.
5
+
6
+ ## Quickstart: Install, authenticate, configure, and use Gemini CLI
7
+
8
+ Gemini CLI brings the power of advanced language models directly to your command
9
+ line interface. As an AI-powered assistant, Gemini CLI can help you with a
10
+ variety of tasks, from understanding and generating code to reviewing and
11
+ editing documents.
12
+
13
+ ## Install
14
+
15
+ The standard method to install and run Gemini CLI uses `npm`:
16
+
17
+ ```bash
18
+ npm install -g @dgxo/mashadevcli
19
+ ```
20
+
21
+ Once Gemini CLI is installed, run Gemini CLI from your command line:
22
+
23
+ ```bash
24
+ gemini
25
+ ```
26
+
27
+ For more installation options, see [Gemini CLI Installation](./installation.md).
28
+
29
+ ## Authenticate
30
+
31
+ To begin using Gemini CLI, you must authenticate with a Google service. In most
32
+ cases, you can log in with your existing Google account:
33
+
34
+ 1. Run Gemini CLI after installation:
35
+
36
+ ```bash
37
+ gemini
38
+ ```
39
+
40
+ 2. When asked "How would you like to authenticate for this project?" select **1.
41
+ Login with Google**.
42
+
43
+ 3. Select your Google account.
44
+
45
+ 4. Click on **Sign in**.
46
+
47
+ Certain account types may require you to configure a Google Cloud project. For
48
+ more information, including other authentication methods, see
49
+ [Gemini CLI Authentication Setup](./authentication.md).
50
+
51
+ ## Configure
52
+
53
+ Gemini CLI offers several ways to configure its behavior, including environment
54
+ variables, command-line arguments, and settings files.
55
+
56
+ To explore your configuration options, see
57
+ [Gemini CLI Configuration](../reference/configuration.md).
58
+
59
+ ## Use
60
+
61
+ Once installed and authenticated, you can start using Gemini CLI by issuing
62
+ commands and prompts in your terminal. Ask it to generate code, explain files,
63
+ and more.
64
+
65
+ To explore the power of Gemini CLI, see [Gemini CLI examples](./examples.md).
66
+
67
+ ## Check usage and quota
68
+
69
+ You can check your current token usage and quota information using the
70
+ `/stats model` command. This command provides a snapshot of your current
71
+ session's token usage, as well as your overall quota and usage for the supported
72
+ models.
73
+
74
+ For more information on the `/stats` command and its subcommands, see the
75
+ [Command Reference](../../reference/commands.md#stats).
76
+
77
+ ## Next steps
78
+
79
+ - Follow the [File management](../cli/tutorials/file-management.md) guide to
80
+ start working with your codebase.
81
+ - See [Shell commands](../cli/tutorials/shell-commands.md) to learn about
82
+ terminal integration.
@@ -0,0 +1,174 @@
1
+ # Gemini CLI installation, execution, and releases
2
+
3
+ This document provides an overview of Gemini CLI's system requirements,
4
+ installation methods, and release types.
5
+
6
+ ## Recommended system specifications
7
+
8
+ - **Operating System:**
9
+ - macOS 15+
10
+ - Windows 11 24H2+
11
+ - Ubuntu 20.04+
12
+ - **Hardware:**
13
+ - "Casual" usage: 4GB+ RAM (short sessions, common tasks and edits)
14
+ - "Power" usage: 16GB+ RAM (long sessions, large codebases, deep context)
15
+ - **Runtime:** Node.js 20.0.0+
16
+ - **Shell:** Bash, Zsh, or PowerShell
17
+ - **Location:**
18
+ [Gemini Code Assist supported locations](https://developers.google.com/gemini-code-assist/resources/available-locations#americas)
19
+ - **Internet connection required**
20
+
21
+ ## Install Gemini CLI
22
+
23
+ We recommend most users install Gemini CLI using one of the following
24
+ installation methods:
25
+
26
+ - npm
27
+ - Homebrew
28
+ - MacPorts
29
+ - Anaconda
30
+
31
+ Note that Gemini CLI comes pre-installed on
32
+ [**Cloud Shell**](https://docs.cloud.google.com/shell/docs) and
33
+ [**Cloud Workstations**](https://cloud.google.com/workstations).
34
+
35
+ ### Install globally with npm
36
+
37
+ ```bash
38
+ npm install -g @dgxo/mashadevcli
39
+ ```
40
+
41
+ ### Install globally with Homebrew (macOS/Linux)
42
+
43
+ ```bash
44
+ brew install gemini-cli
45
+ ```
46
+
47
+ ### Install globally with MacPorts (macOS)
48
+
49
+ ```bash
50
+ sudo port install gemini-cli
51
+ ```
52
+
53
+ ### Install with Anaconda (for restricted environments)
54
+
55
+ ```bash
56
+ # Create and activate a new environment
57
+ conda create -y -n gemini_env -c conda-forge nodejs
58
+ conda activate gemini_env
59
+
60
+ # Install Gemini CLI globally via npm (inside the environment)
61
+ npm install -g @dgxo/mashadevcli
62
+ ```
63
+
64
+ ## Run Gemini CLI
65
+
66
+ For most users, we recommend running Gemini CLI with the `gemini` command:
67
+
68
+ ```bash
69
+ gemini
70
+ ```
71
+
72
+ For a list of options and additional commands, see the
73
+ [CLI cheatsheet](/docs/cli/cli-reference.md).
74
+
75
+ You can also run Gemini CLI using one of the following advanced methods:
76
+
77
+ - Run instantly with npx. You can run Gemini CLI without permanent installation.
78
+ - In a sandbox. This method offers increased security and isolation.
79
+ - From the source. This is recommended for contributors to the project.
80
+
81
+ ### Run instantly with npx
82
+
83
+ ```bash
84
+ # Using npx (no installation required)
85
+ npx @dgxo/mashadevcli
86
+ ```
87
+
88
+ You can also execute the CLI directly from the main branch on GitHub, which is
89
+ helpful for testing features still in development:
90
+
91
+ ```bash
92
+ npx https://github.com/DGameGT/mashadev-cli
93
+ ```
94
+
95
+ ### Run in a sandbox (Docker/Podman)
96
+
97
+ For security and isolation, Gemini CLI can be run inside a container. This is
98
+ the default way that the CLI executes tools that might have side effects.
99
+
100
+ - **Directly from the registry:** You can run the published sandbox image
101
+ directly. This is useful for environments where you only have Docker and want
102
+ to run the CLI.
103
+ ```bash
104
+ # Run the published sandbox image
105
+ docker run --rm -it us-docker.pkg.dev/gemini-code-dev/gemini-cli/sandbox:0.1.1
106
+ ```
107
+ - **Using the `--sandbox` flag:** If you have Gemini CLI installed locally
108
+ (using the standard installation described above), you can instruct it to run
109
+ inside the sandbox container.
110
+ ```bash
111
+ gemini --sandbox -y -p "your prompt here"
112
+ ```
113
+
114
+ ### Run from source (recommended for Gemini CLI contributors)
115
+
116
+ Contributors to the project will want to run the CLI directly from the source
117
+ code.
118
+
119
+ - **Development mode:** This method provides hot-reloading and is useful for
120
+ active development.
121
+ ```bash
122
+ # From the root of the repository
123
+ npm run start
124
+ ```
125
+ - **Production-like mode (linked package):** This method simulates a global
126
+ installation by linking your local package. It's useful for testing a local
127
+ build in a production workflow.
128
+
129
+ ```bash
130
+ # Link the local cli package to your global node_modules
131
+ npm link packages/cli
132
+
133
+ # Now you can run your local version using the `gemini` command
134
+ gemini
135
+ ```
136
+
137
+ ## Releases
138
+
139
+ Gemini CLI has three release channels: nightly, preview, and stable. For most
140
+ users, we recommend the stable release, which is the default installation.
141
+
142
+ ### Stable
143
+
144
+ New stable releases are published each week. The stable release is the promotion
145
+ of last week's `preview` release along with any bug fixes. The stable release
146
+ uses `latest` tag, but omitting the tag also installs the latest stable release
147
+ by default:
148
+
149
+ ```bash
150
+ # Both commands install the latest stable release.
151
+ npm install -g @dgxo/mashadevcli
152
+ npm install -g @dgxo/mashadevcli@latest
153
+ ```
154
+
155
+ ### Preview
156
+
157
+ New preview releases will be published each week. These releases are not fully
158
+ vetted and may contain regressions or other outstanding issues. Try out the
159
+ preview release by using the `preview` tag:
160
+
161
+ ```bash
162
+ npm install -g @dgxo/mashadevcli@preview
163
+ ```
164
+
165
+ ### Nightly
166
+
167
+ Nightly releases are published every day. The nightly release includes all
168
+ changes from the main branch at time of release. It should be assumed there are
169
+ pending validations and issues. You can help test the latest changes by
170
+ installing with the `nightly` tag:
171
+
172
+ ```bash
173
+ npm install -g @dgxo/mashadevcli@nightly
174
+ ```