summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMark McDonald <[email protected]>2025-06-23 15:07:18 +0800
committerGitHub <[email protected]>2025-06-23 07:07:18 +0000
commit7b39dd8b28a1eb39de77408687681cc2efb7b229 (patch)
treef5d52fd1d7f17a21db017eb12191396ee29b1476
parentd0800ab9177bf522555e25047629635dd15190b0 (diff)
Added some use cases to the README (#1257)
-rw-r--r--README.md50
1 files changed, 49 insertions, 1 deletions
diff --git a/README.md b/README.md
index ed50cf8b..ddb55f99 100644
--- a/README.md
+++ b/README.md
@@ -42,6 +42,8 @@ Or ask it to perform a task using its tools:
> List files in the current directory.
```
+Take a look at some [popular tasks](#popular-tasks) for more inspiration.
+
## Authentication Setup
The Gemini CLI requires you to authenticate with Google's AI services. On initial startup you'll need to configure **one** of the following authentication methods:
@@ -117,7 +119,53 @@ The Gemini CLI requires you to authenticate with Google's AI services. On initia
source ~/.bashrc
```
-### Next Steps
+## Popular tasks
+
+### Explore a new codebase
+
+Start by `cd`ing into an existing or newly-cloned repository and running `gemini`.
+
+```text
+> Describe the main pieces of this system's architecture.
+```
+
+```text
+> What security mechanisms are in place?
+```
+
+### Work with your existing code
+
+```text
+> Implement a first draft for GitHub issue #123.
+```
+
+```text
+> Help me migrate this codebase to the latest version of Java. Start with a plan.
+```
+
+### Automate your workflows
+
+Use MCP servers to integrate your local system tools with your enterprise collaboration suite.
+
+```text
+> Make me a slide deck showing the git history from the last 7 days, grouped by feature and team member.
+```
+
+```text
+> Make a full-screen web app for a wall display to show our most interacted-with GitHub issues.
+```
+
+### Interact with your system
+
+```text
+> Convert all the images in this directory to png, and rename them to use dates from the exif data.
+```
+
+```text
+> Organise my PDF invoices by month of expenditure.
+```
+
+### Next steps
- Learn how to [contribute to or build from the source](./CONTRIBUTING.md).
- Explore the available **[CLI Commands](./docs/cli/commands.md)**.