Skip to content

Commit 6e7f278

Browse files
authored
Update README.md to fix some issues (#99)
1 parent 7d1c3c9 commit 6e7f278

File tree

1 file changed

+31
-28
lines changed

1 file changed

+31
-28
lines changed

README.md

Lines changed: 31 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -43,31 +43,34 @@ gemini extensions uninstall flutter
4343
**Note for Windows users:** There is currently a [known issue](https://github.com/google-gemini/gemini-cli/issues/10616) with installing extensions on Gemini CLI for Windows. The workaround is as follows:
4444

4545
1. Follow instructions above to attempt to install the plugin (this will fail).
46-
```bash
47-
gemini extensions install https://github.com/gemini-cli-extensions/flutter.git
48-
```
49-
46+
47+
```bash
48+
gemini extensions install https://github.com/gemini-cli-extensions/flutter.git
49+
```
50+
5051
2. In the command line, navigate to the folder in the home user's path where the code was downloaded (USER is the user's username)
51-
```bash
52-
cd %TEMP%
53-
```
54-
55-
3. Locate the folder for the downloaded extension. It will be the latest titled "gemini-extension<hash>" where <hash> is a 6 character string. Change into this directory.
56-
```bash
57-
cd gemini-extension123456
58-
```
52+
53+
```bash
54+
cd %TEMP%
55+
```
56+
57+
3. Locate the folder for the downloaded extension. It will be the latest titled `gemini-extension<hash>` where `<hash>` is a 6 character string. Change into this directory.
58+
59+
```bash
60+
cd gemini-extension123456
61+
```
5962

6063
4. There should be a zip file in this folder called "win32.flutter.zip". Unpack this file using `tar` (available in modern Windows versions) or by right-clicking it in File Explorer and selecting "Extract All...".
6164

62-
```bash
63-
tar xvf win32.flutter.zip
64-
```
65+
```bash
66+
tar xvf win32.flutter.zip
67+
```
6568

6669
5. Use the path flag to gemini installation
6770

68-
```bash
69-
gemini extensions install --path %TEMP%\gemini-extension123456
70-
```
71+
```bash
72+
gemini extensions install --path %TEMP%\gemini-extension123456
73+
```
7174

7275
### 2. Available Commands
7376

@@ -132,24 +135,24 @@ Prepares your staged `git` changes for a clean, high-quality commit. It acts as
132135
This extension enforces a specific set of coding standards to ensure consistency and quality. These rules are defined in the extension's repository:
133136

134137
- **`flutter.md`**: Contains rules and best practices for writing Dart and Flutter code. These rules are opinionated, and we encourage you to review them to ensure they align with your style.
135-
- **`override`**: Contains important, high-priority rules that are appended to the end of all prompts to ensure they have the most weight.
136138

137139
## Connecting to a running app
140+
138141
You can connect to an app by providing the Flutter extension with the URL for
139142
the Dart Tooling Daemon:
140143

141144
1. **Run the app**: in VSCode on a target device (iOS, Android, macOS, or web)
142145
2. **Execute the Copy DTD Uri action**: Open the VSCode Command Runner
143-
(Cmd+Shift+P, or Ctrl+Shift+P) and type "Copy DTD Uri to Clipboard" to copy the
144-
DTD URL to your clipboard
146+
(Cmd+Shift+P, or Ctrl+Shift+P) and type "Copy DTD Uri to Clipboard" to copy the
147+
DTD URL to your clipboard
145148
3. **Paste the URL into Gemini CLI**: Enter a prompt like "Connect to the
146-
Flutter app with this DTD URL: " and paste the URL from your clipboard. You
147-
should see a "Connection succeeded" message from the
148-
connect_dart_tooling_daemon MCP tool.
149+
Flutter app with this DTD URL: " and paste the URL from your clipboard. You
150+
should see a "Connection succeeded" message from the
151+
connect_dart_tooling_daemon MCP tool.
149152

150153
Alternatively, you can run from the command line with the `--print-dtd` flag:
151154

152-
```
155+
```bash
153156
$ flutter run --print-dtd
154157
...
155158
The Dart Tooling Daemon is available at: ws://127.0.0.1:52636/M3G9d1Q3hFk=
@@ -162,9 +165,9 @@ page on dart.dev or the
162165

163166
## Known issues
164167

165-
* Running a Flutter app from within Gemini CLI and then triggering a Hot Reload
166-
does not work in Flutter stable <= 3.35.4.
167-
Tracking issue: https://github.com/flutter/gemini-cli-extension/issues/82
168+
- Running a Flutter app from within Gemini CLI and then triggering a Hot Reload
169+
does not work in Flutter stable <= 3.37.0.
170+
Tracking issue: [flutter/gemini-cli-extension#82](https://github.com/flutter/gemini-cli-extension/issues/82)
168171

169172
## 🐛 Troubleshooting
170173

0 commit comments

Comments
 (0)