Insomnia is an open-source, cross-platform API client for GraphQL, REST, WebSockets, Server-sent events and gRPC.
Insomnia is available for Mac, Windows, and Linux and can be downloaded from the website.
https://insomnia.rest/download
Have a bug or a feature request? First, read the issue guidelinesand search for existing and closed issues. If your problem or idea is not addressed yet,please open a new issue.
For more generic product questions and feedback, join theSlack Team.
Please read through ourcontributing guidelinesandcode of conduct.Included are directions for opening issues, coding standards, and notes on development.
Check out our open-sourceInsomnia Documentation.
Development on Insomnia can be done on Mac, Windows, or Linux as long as you haveNode.jsandGit.See the.nvmrc
file located in the project for the correct Node version.
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 rootpackage.json
and can be accessed using thenpm run…
command. Here are the only three commands you should need to start developing on the app.
#Install and Link Dependencies
npm i
#Run Lint
npm run lint
#Run type checking
npm run type-check
#Run Tests
npmtest
#Start App with Live Reload
npm run dev
If you are on Linux, you may need to install the following supporting packages:
Ubuntu/Debian
#Update library
sudo apt-get update
#Install font configuration library & support
sudo apt-get install libfontconfig-dev
Fedora
#Install libcurl for node-libcurl
sudo dnf install libcurl-devel
Also on Linux, if Electron is failing during the install process, run the following
#Clear Electron install conflicts
rm -rf~/.cache/electron
If you are on Windows and have problems, you may need to installWindows Build Tools
Editor Requirements
You can use any editor you'd like, but make sure to have support/plugins for the following tools:
- ESLint- For catching syntax problems and common errors
- JSX Syntax- For React components
npm i
- Start the compiler in watch mode:
npm run inso-start
- Run:
./packages/insomnia-inso/bin/inso -v
Search for, discover, and install plugins from the InsomniaPlugin Hub!
- Insomnia Documenter- Generate beautiful API documentation pages using thedocumenter pluginor 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- GenerateSwaggerdocumentation for your existing API in Insomnia.