mirror of
https://github.com/google-gemini/gemini-cli
synced 2026-04-21 13:37:17 +00:00
Update README.md for links. (#22759)
This commit is contained in:
parent
4e21e5b8a3
commit
597778e55f
1 changed files with 58 additions and 50 deletions
108
README.md
108
README.md
|
|
@ -30,7 +30,7 @@ Learn all about Gemini CLI in our [documentation](https://geminicli.com/docs/).
|
||||||
## 📦 Installation
|
## 📦 Installation
|
||||||
|
|
||||||
See
|
See
|
||||||
[Gemini CLI installation, execution, and releases](./docs/get-started/installation.md)
|
[Gemini CLI installation, execution, and releases](https://www.geminicli.com/docs/get-started/installation)
|
||||||
for recommended system specifications and a detailed installation guide.
|
for recommended system specifications and a detailed installation guide.
|
||||||
|
|
||||||
### Quick Install
|
### Quick Install
|
||||||
|
|
@ -71,9 +71,9 @@ conda activate gemini_env
|
||||||
npm install -g @google/gemini-cli
|
npm install -g @google/gemini-cli
|
||||||
```
|
```
|
||||||
|
|
||||||
## Release Cadence and Tags
|
## Release Channels
|
||||||
|
|
||||||
See [Releases](./docs/releases.md) for more details.
|
See [Releases](https://www.geminicli.com/docs/changelogs) for more details.
|
||||||
|
|
||||||
### Preview
|
### Preview
|
||||||
|
|
||||||
|
|
@ -209,7 +209,7 @@ gemini
|
||||||
```
|
```
|
||||||
|
|
||||||
For Google Workspace accounts and other authentication methods, see the
|
For Google Workspace accounts and other authentication methods, see the
|
||||||
[authentication guide](./docs/get-started/authentication.md).
|
[authentication guide](https://www.geminicli.com/docs/get-started/authentication).
|
||||||
|
|
||||||
## 🚀 Getting Started
|
## 🚀 Getting Started
|
||||||
|
|
||||||
|
|
@ -278,59 +278,64 @@ gemini
|
||||||
|
|
||||||
### Getting Started
|
### Getting Started
|
||||||
|
|
||||||
- [**Quickstart Guide**](./docs/get-started/index.md) - Get up and running
|
- [**Quickstart Guide**](https://www.geminicli.com/docs/get-started) - Get up
|
||||||
quickly.
|
and running quickly.
|
||||||
- [**Authentication Setup**](./docs/get-started/authentication.md) - Detailed
|
- [**Authentication Setup**](https://www.geminicli.com/docs/get-started/authentication) -
|
||||||
auth configuration.
|
Detailed auth configuration.
|
||||||
- [**Configuration Guide**](./docs/reference/configuration.md) - Settings and
|
- [**Configuration Guide**](https://www.geminicli.com/docs/reference/configuration) -
|
||||||
customization.
|
Settings and customization.
|
||||||
- [**Keyboard Shortcuts**](./docs/reference/keyboard-shortcuts.md) -
|
- [**Keyboard Shortcuts**](https://www.geminicli.com/docs/reference/keyboard-shortcuts) -
|
||||||
Productivity tips.
|
Productivity tips.
|
||||||
|
|
||||||
### Core Features
|
### Core Features
|
||||||
|
|
||||||
- [**Commands Reference**](./docs/reference/commands.md) - All slash commands
|
- [**Commands Reference**](https://www.geminicli.com/docs/reference/commands) -
|
||||||
(`/help`, `/chat`, etc).
|
All slash commands (`/help`, `/chat`, etc).
|
||||||
- [**Custom Commands**](./docs/cli/custom-commands.md) - Create your own
|
- [**Custom Commands**](https://www.geminicli.com/docs/cli/custom-commands) -
|
||||||
reusable commands.
|
Create your own reusable commands.
|
||||||
- [**Context Files (GEMINI.md)**](./docs/cli/gemini-md.md) - Provide persistent
|
- [**Context Files (GEMINI.md)**](https://www.geminicli.com/docs/cli/gemini-md) -
|
||||||
context to Gemini CLI.
|
Provide persistent context to Gemini CLI.
|
||||||
- [**Checkpointing**](./docs/cli/checkpointing.md) - Save and resume
|
- [**Checkpointing**](https://www.geminicli.com/docs/cli/checkpointing) - Save
|
||||||
conversations.
|
and resume conversations.
|
||||||
- [**Token Caching**](./docs/cli/token-caching.md) - Optimize token usage.
|
- [**Token Caching**](https://www.geminicli.com/docs/cli/token-caching) -
|
||||||
|
Optimize token usage.
|
||||||
|
|
||||||
### Tools & Extensions
|
### Tools & Extensions
|
||||||
|
|
||||||
- [**Built-in Tools Overview**](./docs/reference/tools.md)
|
- [**Built-in Tools Overview**](https://www.geminicli.com/docs/reference/tools)
|
||||||
- [File System Operations](./docs/tools/file-system.md)
|
- [File System Operations](https://www.geminicli.com/docs/tools/file-system)
|
||||||
- [Shell Commands](./docs/tools/shell.md)
|
- [Shell Commands](https://www.geminicli.com/docs/tools/shell)
|
||||||
- [Web Fetch & Search](./docs/tools/web-fetch.md)
|
- [Web Fetch & Search](https://www.geminicli.com/docs/tools/web-fetch)
|
||||||
- [**MCP Server Integration**](./docs/tools/mcp-server.md) - Extend with custom
|
- [**MCP Server Integration**](https://www.geminicli.com/docs/tools/mcp-server) -
|
||||||
tools.
|
Extend with custom tools.
|
||||||
- [**Custom Extensions**](./docs/extensions/index.md) - Build and share your own
|
- [**Custom Extensions**](https://geminicli.com/docs/extensions/writing-extensions) -
|
||||||
commands.
|
Build and share your own commands.
|
||||||
|
|
||||||
### Advanced Topics
|
### Advanced Topics
|
||||||
|
|
||||||
- [**Headless Mode (Scripting)**](./docs/cli/headless.md) - Use Gemini CLI in
|
- [**Headless Mode (Scripting)**](https://www.geminicli.com/docs/cli/headless) -
|
||||||
automated workflows.
|
Use Gemini CLI in automated workflows.
|
||||||
- [**IDE Integration**](./docs/ide-integration/index.md) - VS Code companion.
|
- [**IDE Integration**](https://www.geminicli.com/docs/ide-integration) - VS
|
||||||
- [**Sandboxing & Security**](./docs/cli/sandbox.md) - Safe execution
|
Code companion.
|
||||||
environments.
|
- [**Sandboxing & Security**](https://www.geminicli.com/docs/cli/sandbox) - Safe
|
||||||
- [**Trusted Folders**](./docs/cli/trusted-folders.md) - Control execution
|
execution environments.
|
||||||
policies by folder.
|
- [**Trusted Folders**](https://www.geminicli.com/docs/cli/trusted-folders) -
|
||||||
- [**Enterprise Guide**](./docs/cli/enterprise.md) - Deploy and manage in a
|
Control execution policies by folder.
|
||||||
corporate environment.
|
- [**Enterprise Guide**](https://www.geminicli.com/docs/cli/enterprise) - Deploy
|
||||||
- [**Telemetry & Monitoring**](./docs/cli/telemetry.md) - Usage tracking.
|
and manage in a corporate environment.
|
||||||
- [**Tools reference**](./docs/reference/tools.md) - Built-in tools overview.
|
- [**Telemetry & Monitoring**](https://www.geminicli.com/docs/cli/telemetry) -
|
||||||
- [**Local development**](./docs/local-development.md) - Local development
|
Usage tracking.
|
||||||
tooling.
|
- [**Tools reference**](https://www.geminicli.com/docs/reference/tools) -
|
||||||
|
Built-in tools overview.
|
||||||
|
- [**Local development**](https://www.geminicli.com/docs/local-development) -
|
||||||
|
Local development tooling.
|
||||||
|
|
||||||
### Troubleshooting & Support
|
### Troubleshooting & Support
|
||||||
|
|
||||||
- [**Troubleshooting Guide**](./docs/resources/troubleshooting.md) - Common
|
- [**Troubleshooting Guide**](https://www.geminicli.com/docs/resources/troubleshooting) -
|
||||||
issues and solutions.
|
Common issues and solutions.
|
||||||
- [**FAQ**](./docs/resources/faq.md) - Frequently asked questions.
|
- [**FAQ**](https://www.geminicli.com/docs/resources/faq) - Frequently asked
|
||||||
|
questions.
|
||||||
- Use `/bug` command to report issues directly from the CLI.
|
- Use `/bug` command to report issues directly from the CLI.
|
||||||
|
|
||||||
### Using MCP Servers
|
### Using MCP Servers
|
||||||
|
|
@ -344,8 +349,9 @@ custom tools:
|
||||||
> @database Run a query to find inactive users
|
> @database Run a query to find inactive users
|
||||||
```
|
```
|
||||||
|
|
||||||
See the [MCP Server Integration guide](./docs/tools/mcp-server.md) for setup
|
See the
|
||||||
instructions.
|
[MCP Server Integration guide](https://www.geminicli.com/docs/tools/mcp-server)
|
||||||
|
for setup instructions.
|
||||||
|
|
||||||
## 🤝 Contributing
|
## 🤝 Contributing
|
||||||
|
|
||||||
|
|
@ -366,7 +372,8 @@ for planned features and priorities.
|
||||||
## 📖 Resources
|
## 📖 Resources
|
||||||
|
|
||||||
- **[Official Roadmap](./ROADMAP.md)** - See what's coming next.
|
- **[Official Roadmap](./ROADMAP.md)** - See what's coming next.
|
||||||
- **[Changelog](./docs/changelogs/index.md)** - See recent notable updates.
|
- **[Changelog](https://www.geminicli.com/docs/changelogs)** - See recent
|
||||||
|
notable updates.
|
||||||
- **[NPM Package](https://www.npmjs.com/package/@google/gemini-cli)** - Package
|
- **[NPM Package](https://www.npmjs.com/package/@google/gemini-cli)** - Package
|
||||||
registry.
|
registry.
|
||||||
- **[GitHub Issues](https://github.com/google-gemini/gemini-cli/issues)** -
|
- **[GitHub Issues](https://github.com/google-gemini/gemini-cli/issues)** -
|
||||||
|
|
@ -376,13 +383,14 @@ for planned features and priorities.
|
||||||
|
|
||||||
### Uninstall
|
### Uninstall
|
||||||
|
|
||||||
See the [Uninstall Guide](./docs/resources/uninstall.md) for removal
|
See the [Uninstall Guide](https://www.geminicli.com/docs/resources/uninstall)
|
||||||
instructions.
|
for removal instructions.
|
||||||
|
|
||||||
## 📄 Legal
|
## 📄 Legal
|
||||||
|
|
||||||
- **License**: [Apache License 2.0](LICENSE)
|
- **License**: [Apache License 2.0](LICENSE)
|
||||||
- **Terms of Service**: [Terms & Privacy](./docs/resources/tos-privacy.md)
|
- **Terms of Service**:
|
||||||
|
[Terms & Privacy](https://www.geminicli.com/docs/resources/tos-privacy)
|
||||||
- **Security**: [Security Policy](SECURITY.md)
|
- **Security**: [Security Policy](SECURITY.md)
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue