CLI.md

CLI

install node version of libcurl

npm install will download the electron version of libcurl but for inso we need the node version

node_modules/.bin/node-pre-gyp install --update-binary --directory node_modules/@getinsomnia/node-libcurl

to download the electron version of node-libcurl you should remove the module and npm install again

rm -rf node_modules/@getinsomnia/
npm install

Run CLI Smoke Tests

# Package the Inso CLI binaries
npm run inso-package

# Run CLI tests
npm run test:smoke:cli

Debugging CLI tests using watcher

This is helpful for debugging failing api tests and changing the send-request abstraction

From project root, in separate terminals:

# start smoke test api
npm run serve -w packages/insomnia-smoke-test

# build send-request
npm run build:sr -w packages/insomnia

# watch inso
npm run start -w packages/insomnia-inso

# run api test with dev bundle
$PWD/packages/insomnia-inso/bin/inso run test "Echo Test Suite" --src $PWD/packages/insomnia-smoke-test/fixtures/inso-nedb --env Dev --verbose

How to debug pkg

# run modify package command and then a unit test
npm run package -w packages/insomnia-inso && \
$PWD/packages/insomnia-inso/binaries/inso run test "Echo Test Suite" --src $PWD/packages/insomnia-smoke-test/fixtures/inso-nedb --env Dev --verbose

How to update the inso-nedb fixtures

Run Insomnia with INSOMNIA_DATA_PATH environment variable set to fixtures/inso-nedb, e.g.:

INSOMNIA_DATA_PATH=packages/insomnia-smoke-test/fixtures/inso-nedb /Applications/Insomnia.app/Contents/MacOS/Insomnia

Relaunch the app one more time, so that Insomnia compacts the database.

The .gitignore file will explicitly ignore certain database files, to keep the directory size down and avoid prevent sensitive data leaks.

How to run inso with the inso-nedb fixture locally?

Set the --src argument pointed to packages/insomnia-smoke-test/fixtures/inso-nedb:

# if installed globally
inso --src <INSO_NEDB_PATH>

# using the package bin
./packages/insomnia-inso/bin/inso --src <INSO_NEDB_PATH>

# using a binary
./packages/insomnia-inso/binaries/insomnia-inso --src <INSO_NEDB_PATH>