search-with-chatgpt-powered-by-openai-extension/docs/amo/README.md

# Add-ons listing

Paste-ready text and images for the
[addons.mozilla.org listing](https://addons.mozilla.org/en-US/firefox/addon/search-with-chatgpt/).
Edit them in the AMO Developer Hub under the add-on's listing details.

Listing copy follows the copy rule in the
[options design](../superpowers/specs/2026-07-29-extension-options-design.md):
ChatGPT opens with the text *filled in*. Never say the text is sent, searched,
or asked. Keep "private", "incognito", and "secure" away from temporary chat,
and call temporary chat and web search hints.

## Branding

The name's "powered by OpenAI" and the extension's own icon follow OpenAI's
brand guidelines on purpose:
- OpenAI's logo would make unofficial software look official, so it isn't
  used.
- "Powered by OpenAI" is one of the phrases the guidelines allow.

Keep both, along with the description's "unofficial" line.

## Summary

Plain text, 250 characters at most. The summary isn't Markdown, and AMO escapes
`<` and `>` in it, so `<Alt>` would show as `&lt;Alt&gt;`. The summary is the one
place that writes the shortcut without angle brackets:

```text
Ask ChatGPT from anywhere in Firefox. Type gpt in the address bar, right-click selected text, press Alt+Shift+G, or click the toolbar button. ChatGPT opens with your text filled in. Tiny, fast, no API key.
```

## Description

Since March 2025, AMO formats descriptions as
[Markdown](https://blog.mozilla.org/addons/2025/03/03/markdown/) and shows any
HTML as plain text. Plain `<Ctrl>` therefore shows as typed. Check the preview
after saving.

```markdown
Ask ChatGPT from anywhere in Firefox.

**Four ways to use it**

- **Address bar:** press <Ctrl>+L, type `gpt` and your question, like `gpt why does my cat knock things over?`, and press <Enter>.
- **Right-click:** select text on any page and choose Ask ChatGPT.
- **Keyboard:** select text and press <Alt>+<Shift>+G. With nothing selected, it opens a blank chat.
- **Toolbar:** click the Ask ChatGPT button.

ChatGPT opens with your text filled in. You may need to sign in to ChatGPT.

**Small on purpose**

The whole extension is about 56 KB, with no libraries, no server, no API key and no intermediary, and nothing is reported to us. Firefox opens chatgpt.com directly, and it never makes ChatGPT your default search engine unless you choose to.

**Make it yours**

- A simple right-click menu, or an advanced one with Explain, Summarize, Debug code and Translate.
- Your own prompt template, like `Explain simply: {query}`.
- Open ChatGPT in a new tab, a background tab or a new window.
- Ask for a temporary chat or a web search. These are hints, and ChatGPT decides whether to honour them.
- Add your own search keyword or change the shortcut in Firefox's settings.

Search with ChatGPT is an unofficial extension by Zavage Software and isn't affiliated with OpenAI.

[Source code](https://git-repos.zavage.net/zavage-software/search-with-chatgpt-powered-by-openai-extension) · [Project website](https://zavage-software.com/portfolio/search-with-ChatGPT) · [Feedback or report a bug](https://zavage-software.com/contact-us)
```

Update "about 56 KB" when the package size changes noticeably. `npm run build`
prints the ZIP's path.

## Screenshots

Upload in this order, with these captions. Each image is 1280×800, the size AMO
recommends, and carries no added text, as Mozilla's listing guide advises.

The images are not committed. Generate them as described under
[Regenerating the images](#regenerating-the-images); they land in
`docs/amo/screenshots/`, which git ignores, so the links below work once you
have.

| Image | Caption |
|---|---|
| [1-address-bar.png](screenshots/1-address-bar.png) | Type gpt and your question in the address bar. ChatGPT opens with it filled in. |
| [2-right-click.png](screenshots/2-right-click.png) | Select text on any page, right-click, and choose Ask ChatGPT. |
| [3-keyboard.png](screenshots/3-keyboard.png) | Or select text and press <Alt>+<Shift>+G. |
| [4-toolbar.png](screenshots/4-toolbar.png) | Or click the Ask ChatGPT button in the toolbar. |
| [5-advanced-menu.png](screenshots/5-advanced-menu.png) | Switch to the Advanced menu for Explain, Summarize, Debug code and Translate. |

A real screenshot of the options page in `about:addons` makes a good sixth
image: one genuine screenshot next to the drawings helps people trust them.
Suggested caption: "Every setting on one simple page."

## Regenerating the images

The images are the options page's drawings, enlarged by
[`screenshots.html`](screenshots.html), which reuses `options/options.css`. They
are generated rather than committed, like the build ZIP. When a drawing in
`options/options.html` changes, copy the change into `screenshots.html`. Then,
to produce the images, run these from the repository root:

```sh
python3 -m http.server 8766 --bind 127.0.0.1 &
profile=$(mktemp -d)
echo 'user_pref("layout.css.prefers-color-scheme.content-override", 1);' > "$profile/user.js"
for shot in 1-address-bar 2-right-click 3-keyboard 4-toolbar 5-advanced-menu; do
  firefox --headless -no-remote -profile "$profile" --window-size=1280,800 \
    --screenshot "$PWD/docs/amo/screenshots/$shot.png" \
    "http://127.0.0.1:8766/docs/amo/screenshots.html#$shot"
done
kill %1
```

The output path must be absolute. The throwaway profile forces the light theme,
and a fresh one avoids Firefox serving an old copy of the page from its cache.
Opening `screenshots.html` without a `#fragment` shows every image in order.