Skip to content

Commit b727d27

Browse files
authored
docs: Update README to Amazon Q (#2339)
1 parent 2b5ab4d commit b727d27

File tree

1 file changed

+50
-110
lines changed

1 file changed

+50
-110
lines changed

README.md

Lines changed: 50 additions & 110 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,38 @@
1-
<p align="center">
2-
<img width="300" alt="Fig logo" src="https://raw.githubusercontent.com/withfig/fig/main/static/FigBanner.png#gh-light-mode-only"/>
3-
<img width="300" alt="Fig logo" src="https://raw.githubusercontent.com/withfig/fig/main/static/FigBannerInverted.png#gh-dark-mode-only"/>
4-
</p>
5-
6-
---
7-
81
[![Badge: macOS](https://img.shields.io/badge/os-%20macOS-light)](#)
9-
[![Badge: Sign up (public beta)](https://img.shields.io/badge/signup-public%20beta-blueviolet)](https://fig.io?ref=github_autocomplete)
102
[![Badge: Documentation](https://img.shields.io/badge/documentation-black)](https://fig.io/docs/)
113
[![Badge: contributors](https://img.shields.io/github/contributors/withfig/autocomplete)](#Contributors)
12-
[![Badge: Join the Discord server](https://img.shields.io/discord/837809111248535583?color=5865F2&label=discord)](https://fig.io/community)
13-
[![Badge: Follow on Twitter](https://img.shields.io/twitter/follow/fig.svg?style=social&label=Follow)](https://twitter.com/intent/follow?screen_name=fig)
144

15-
**[Fig](https://fig.io?ref=github_autocomplete) makes the command line easier
16-
for individuals and more collaborative for teams.**
17-
18-
Our most popular product is Autocomplete. As you type, Fig pops up subcommands,
19-
options, and contextually relevant arguments in your existing terminal.
5+
**[Amazon Q Developer in the command line](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-getting-started-installing.html)
6+
adds IDE-style completions for hundreds of popular CLIs like `git`, `npm`,
7+
`docker`, and `aws`. Start typing, and Amazon Q populates contextually relevant
8+
subcommands, options and arguments.**
209

2110
## ⚡️ Installation
2211

2312
- **macOS**:
24-
- **DMG**: Download from our website: [fig.io](https://fig.io/welcome)
25-
- **Homebrew**: `brew install fig`
26-
- **Windows/Linux**:
27-
- Join the [waitlist](https://withfig.typeform.com/linux)
13+
- **DMG**: Download from AWS:
14+
[aws.amazon.com](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-getting-started-installing.html)
15+
- **Homebrew**: `brew install amazon-q`
16+
- **Linux/Windows**:
17+
- Follow the discussions for
18+
[Linux](https://github.com/aws/q-command-line-discussions/discussions/14) or
19+
[Windows](https://github.com/aws/q-command-line-discussions/discussions/15)
2820
- **Remote machines**
29-
- [Autocomplete in SSH](https://fig.io/user-manual/autocomplete/ssh)
30-
- [Autocomplete in Docker Containers](https://fig.io/user-manual/autocomplete/docker)
21+
- [Autocomplete in SSH](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-autocomplete-ssh.html)
3122

32-
> NOTE: Once it's downloaded, launch the app to set up Fig!
23+
> NOTE: Once it's downloaded, launch the app to set up Amazon Q for command
24+
> line!
3325
3426
<br/>
3527

36-
![Demo of Fig's visual autocomplete in a terminal](https://fig.io/gifs/demo-with-header.gif)
28+
![Demo of Amazon Q's CLI Completions in a terminal](https://docs.aws.amazon.com/images/amazonq/latest/qdeveloper-ug/images/command-line-completions.gif)
3729

3830
<br/>
3931

4032
## 👋 What are "completion specs"?
4133

4234
A completion spec is a _declarative_ schema that specifies the `subcommands`,
43-
`options` and `args` for a CLI tool. Fig uses these schemas to generate
35+
`options` and `args` for a CLI tool. Amazon Q uses these schemas to generate
4436
suggestions.
4537

4638
<br/>
@@ -52,7 +44,7 @@ Use the steps below or follow our getting started guide:
5244

5345
**Prerequisites:**
5446

55-
- Download Fig for macOS
47+
- Download Amazon Q for command line
5648
- Node and Pnpm
5749

5850
<br/>
@@ -69,8 +61,8 @@ Use the steps below or follow our getting started guide:
6961

7062
```bash
7163
# Replace `YOUR_GITHUB_USERNAME` with your own GitHub username
72-
git clone https://github.com/YOUR_GITHUB_USERNAME/autocomplete.git fig-autocomplete
73-
cd fig-autocomplete
64+
git clone https://github.com/YOUR_GITHUB_USERNAME/autocomplete.git autocomplete
65+
cd autocomplete
7466

7567
# Add withfig/autocomplete as a remote
7668
git remote add upstream https://github.com/withfig/autocomplete.git
@@ -97,34 +89,6 @@ Use the steps below or follow our getting started guide:
9789

9890
<br>
9991

100-
## 🪄 Add AI to completions
101-
102-
You can use Fig's autocomplete for your own tools too. Here's how to create
103-
private completions:
104-
105-
```ts
106-
import { ai } from "@fig/autocomplete-generators"
107-
108-
...
109-
110-
generators: [
111-
ai({
112-
// the prompt
113-
prompt: "Generate a git commit message",
114-
115-
// Send any relevant local context.
116-
message: async ({ executeShellCommand }) => {
117-
return executeShellCommand("git diff")
118-
},
119-
120-
// turn each newline into a suggestion (can specify instead a `postProcess1 function if more flexibility is required)
121-
splitOn: "\n",
122-
})
123-
]
124-
```
125-
126-
<br/>
127-
12892
## 📦 Other available package.json commands
12993

13094
```bash
@@ -142,42 +106,25 @@ pnpm lint:fix
142106

143107
We would love contributions for:
144108

145-
- new completion specs
146-
- errors with existing completion specs (e.g. missing subcommands, options, or
109+
- New completion specs
110+
- Errors with existing completion specs (e.g. missing subcommands, options, or
147111
arguments)
148-
- [generators](https://fig.io/docs/getting-started/generating-argument-suggestions)
112+
- [Generators](https://fig.io/docs/getting-started/generating-argument-suggestions)
149113
for argument suggestions
150-
- better descriptions, icons etc
151-
- [themes](https://github.com/withfig/themes)!
114+
- Better descriptions, icons etc
115+
- [Themes](https://github.com/withfig/themes)!
152116

153117
If you aren't able to contribute, please feel free to open an
154118
[issue](https://github.com/withfig/autocomplete/issues/new/choose).
155119

156-
## 😊 Need Help?
157-
158-
<p align="center">
159-
Join our community
160-
<br/>
161-
<a href="https://fig.io/community">
162-
<img alt="Discord logo" src="http://fig.io/icons/discord-logo-square.png" width="80px" height="80px" />
163-
</a>
164-
</p>
165-
166-
## 🧑‍💻 Teams / Enterprise
167-
168-
Want to use Fig to add autocomplete internal CLI tools? Or want to use Fig at
169-
work but have security / compliance concerns?
170-
171-
We would love to help get you set up. Please email
172-
173-
174120
## 🙋‍♀️ FAQ
175121

176-
#### What terminals does Fig work with?
122+
#### What terminals does Amazon Q work with?
177123

178-
Fig works with the native macOS Terminal app, [iTerm], [Tabby], [Hyper],
179-
[Kitty], [WezTerm], and [Alacritty]. It also works in the integrated terminals
180-
of [VSCode], [JetBrains IDEs], [Android Studio], and [Nova].
124+
Amazon Q for command line works with the native macOS Terminal app, [iTerm],
125+
[Tabby], [Hyper], [Kitty], [WezTerm], and [Alacritty]. It also works in the
126+
integrated terminals of [VSCode], [JetBrains IDEs], [Android Studio], and
127+
[Nova].
181128

182129
[iterm]: https://iterm2.com
183130
[tabby]: https://tabby.sh
@@ -191,51 +138,44 @@ of [VSCode], [JetBrains IDEs], [Android Studio], and [Nova].
191138
[nova]: https://nova.app/
192139

193140
Want to see another terminal included? Check our
194-
[issue tracker](https://github.com/withfig/fig) and add your support for it!
141+
[issue tracker](https://github.com/aws/q-command-line-discussions) and add your
142+
support for it!
195143

196-
#### How does Fig work?
144+
#### How does Amazon Q for command line work?
197145

198-
Fig uses the Accessibility API on Mac to position the window, and integrates
199-
with your shell to read what you've typed.
146+
Amazon Q for command line uses the Accessibility API on Mac to position the
147+
window, and integrates with your shell to read what you've typed.
200148

201-
#### Does Fig work on Windows or Linux?
149+
#### Does Amazon Q for command line work on Windows or Linux?
202150

203-
Not yet, Fig is only available on macOS for now.
204-
[Windows](https://github.com/withfig/fig/issues/35) and
205-
[Linux](https://github.com/withfig/fig/issues/34) support is in progress!
151+
Not yet, Amazon Q for command line is only available on macOS for now.
152+
[Windows](https://github.com/aws/q-command-line-discussions/discussions/15) and
153+
[Linux](https://github.com/aws/q-command-line-discussions/discussions/14)
154+
support is in progress!
206155

207-
#### How can I download Fig?
156+
#### How can I download Amazon Q?
208157

209-
Run `brew install fig` or, downloading the app at
210-
[fig.io/download](https://fig.io/download). Then, launch the Fig app!
211-
212-
#### Can I use Fig to build autocomplete for my team's internal scripts and CLI tools?
213-
214-
Yes! Check out our guide on how to
215-
[get started building autocomplete specs](https://fig.io/docs/getting-started).
158+
Run `brew install amazon-q` or, downloading the app at
159+
[aws.amazon.com](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-getting-started-installing.html).
160+
Then, launch the Amazon Q app!
216161

217162
#### How do I submit a PR?
218163

219164
Check out our
220165
[How to Contribute](https://fig.io/docs/getting-started/contributing) guide.
221-
Many of Fig's 200+ contributors made their first open source contribution to
222-
Fig!
223-
224-
#### Fig doesn't work for me!
225-
226-
[Join the Discord server](https://fig.io/community) and we'll debug it. Fixing
227-
Fig in your setup will fix it for other people too! 🙂
166+
Many of Amazon Q's 400+ contributors made their first open source contribution
167+
to Amazon Q!
228168

229-
#### Did we miss something?
169+
#### Amazon Q for command line doesn't work for me!
230170

231-
Get in touch at [email protected] or chat with us on
232-
[Discord](https://fig.io/community).
171+
Run `q doctor` to automatically debug issues with your installation. Otherwise
172+
make an issue in our GitHub discussions community:
173+
[aws/q-command-line-discussions](https://github.com/aws/q-command-line-discussions/discussions)
233174

234175
<br/>
235176

236177
## ✨ Contributors
237178

238179
<a href="https://github.com/withfig/autocomplete/graphs/contributors">
239-
<img alt="Grid of profile icons of the 200+ contributors" src="https://contrib.rocks/image?repo=withfig/autocomplete" />
180+
<img alt="Grid of profile icons of the 400+ contributors" src="https://contrib.rocks/image?repo=withfig/autocomplete" />
240181
</a>
241-
<!-- https://contrib.rocks -->

0 commit comments

Comments
 (0)