Insomnia API Client
Insomnia is an open-source, cross-platform API client for GraphQL, REST, and gRPC.
Insomnia is available for Mac, Windows, and Linux and can be downloaded from the website.
Bugs and Feature Requests
Check out our open-source Insomnia Documentation.
Initial Dev Setup
This repository is structured as a monorepo and contains many Node.JS packages. Each package has its own set of commands, but the most common commands are available from the root
package.json and can be accessed using the
npm run ... command. Here are the only three commands you should need to start developing on the app.
# Install and Link Dependencies npm run bootstrap # Run Tests npm test # Start App with Live Reload npm run app-start
If you are on Linux, you may need to install the following supporting packages:
# Update library sudo apt-get update # Install font configuration library & support sudo apt-get install libfontconfig-dev
# Install libcurl for node-libcurl sudo dnf install libcurl-devel
Also on Linux, if Electron is failing during the bootstrap process, run the following
# Clear Electron install conflicts rm -rf ~/.cache/electron
If you are on Windows and have problems, you may need to install Windows Build Tools
You can use any editor you'd like, but make sure to have support/plugins for the following tools:
Develop Inso CLI
npm run bootstrap
- Start the compiler in watch mode:
npm run inso-start
Search for, discover, and install plugins from the Insomnia Plugin Hub!
- Insomnia Documenter – Generate beautiful API documentation pages using the documenter plugin or your Insomnia export file.
- GitHub API Spec Importer – A complete set of GitHub REST API route specifications that can be imported straight into Insomnia.
- Swaggymnia – Generate Swagger documentation for your existing API in Insomnia.