# Cite As You Write

JabRef allows you to open up a search dialog to search for entries and their citation keys directly from your LaTeX editor and automatically insert them at your current cursor position. It works with different editors, such as TeXstudio, TeXworks, and Emacs.

Make sure you set the path to the application you want to use in JabRefs settings.

To use the Cite As You Write (CAYW) feature, you need to have JabRef running and the HTTP server enabled.

You can enable the HTTP server in **File → Preferences → General** and under the **HTTP Server** section check the box for **Enable HTTP Server**.

## Application setup

For instructions on how to setup your editor to use the CAYW endpoint, please consult the documentation of [Better BibTeX for Zotero](https://retorque.re/zotero-better-bibtex/citing/cayw/index.html).

## Endpoint parameters

We are working on becoming fully compatible with the CAYW endpoint of [Better BibTeX for Zotero](https://retorque.re/zotero-better-bibtex/citing/cayw/index.html). The endpoint is available under `http://localhost:23119/better-bibtex/cayw`.

Currently, the following optional **GET** parameters are supported:

| Parameter     | Description                                                                                   | Default    |
| ------------- | --------------------------------------------------------------------------------------------- | ---------- |
| `probe`       | If set to `true` or any non-empty value, the endpoint returns `ready`                         |            |
| `format`      | The format of the output, for a full list of the supported formats see below                  | `biblatex` |
| `clipboard`   | If set to `true`, the output is copied to the clipboard                                       |            |
| `application` | You can set it to any of the applications listed below to push directly to them               |            |
| `texstudio`   | If set to `true` or any non-empty value, it is the same as if you set `application=texstudio` |            |
| `selected`    | If set to `true` or any non-empty value, it will use the current selected entries in JabRef   |            |
| `select`      | If set to `true` or any non-empty value, it will select the selected entries in JabRef        |            |
| `librarypath` | The path to the library file, if not set, it will use the currently opened library in JabRef  |            |

### Supported formats

Supported values for paramter `format`:

| Format        | Description                                                                                            |
| ------------- | ------------------------------------------------------------------------------------------------------ |
| `biblatex`    | Additional `command` parameter, which allows to use another command for citing, defaults to `autocite` |
| `simple-json` | A simple json containing the entry ID and the citation key                                             |
| `natbib`      | Additional `command` parameter, which defaults to `cite`                                               |
| `latex`       | Additional `command` parameter, which defaults to `cite`                                               |
| `cite`        | Additional `command` parameter, which defaults to `cite`                                               |
| `citep`       | Additional `command` parameter, which defaults to `citep`                                              |
| `citet`       | Additional `command` parameter, which defaults to `citet`                                              |
| `mmd`         | MultiMarkdown                                                                                          |
| `pandoc`      | Pandoc mardown                                                                                         |
| `typst`       | Typst                                                                                                  |

If the `format` parameter used is not supported, `biblatex` will be used.

### Supported applications

Supported values for paramter `application`:

| Application | parameter   |
| ----------- | ----------- |
| emacs       | `emacs`     |
| LyX         | `lyx`       |
| Sublime     | `sublime`   |
| Texmaker    | `texmaker`  |
| TeXShop     | `texshop`   |
| TeXstudio   | `texstudio` |
| TeXworks    | `texworks`  |
| vim         | `vim`       |
| VS Code     | `vscode`    |
| WinEdt      | `winedt`    |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.jabref.org/cite/cite-as-you-write.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.