Steps
1. Install
If you use Exploratory Desktop, expl is already installed. If not, install it with npm. Node.js 20 or later is required.If the first line reads expl <version>, it works.For other ways to install, and for what to do when two copies are installed, see Installation.
2. Sign in
3. Search
Write the search words right after the command. A value written without a flag name, like this, is called a positional argument.--scope all searches content published by other people as well as your own. --type data limits the result to data. An empty result means that nothing matched; it is not a sign-in error. To search for notes, use --type note.
Result
If the result lists content with ids and URLs, the search works.
4. Read
--json prints the server’s result as JSON. In the result below, IDs, URLs, and names are replaced for illustration. Long output is trimmed, so the JSON below is an excerpt, not a complete JSON.
Result
--include-toc to return it, or get the heading ids with --query.
5. Aggregate (optional)
For a data item, first check the column names and types.If something does not work
- The search result is empty: nothing matched. It is not a sign-in error. Change the search words, or use
--scopeall. - You cannot open a browser: in a script or CI, where there is no browser, sign in with an API key instead:
expl server login --with-token(see API keys). For a machine that cannot open a browser, see Sign in. - You see
Run "expl server login".: you are not signed in, or the saved login was rejected. Run expl server login. - You see expl: command not found: open a new terminal and try again.
- You do not know which id to use: use an id from the search result.
- The list of headings (metadata.toc) is missing from a note: add
--include-toc, or get the heading ids with--query.
Next
- Read notes - How to read long notes and get chart numbers.
- Query data - How to write the JSON arguments.
- Automation - Create an API key and run it in CI.
- Use - Find the command for what you want to do.
- Troubleshooting - Find a fix by symptom.
