little-insomniac/little-insomniac

A minimal anti-sleep app for Mac, Windows, and Linux

Site | NPM Module | GitHub Repo

little-insomniac is the official npm module of Little Insomniac, a minimal anti-sleep app for Mac, Windows, and Linux!

🌐 Little Insomniac Works in Node AND browser environments

Yes, this module works in both Node and browser environments, including compatibility with Webpack and Browserify!

🦄 Features

• Getting proxy lists

🔑 Getting an API key

You can use so much of little-insomniac for free, but if you want to do some advanced stuff, you'll need an API key. You can get one by signing up for a Little Insomniac account.

📦 Install Little Insomniac

Option 1: Install via npm

Install with npm if you plan to use little-insomniac in a Node project or in the browser.

npm install little-insomniac

If you plan to use little-insomniac in a browser environment, you will probably need to use Webpack, Browserify, or a similar service to compile it.

const little-insomniac = new (require('little-insomniac'))({
  // Not required, but having one removes limits (get your key at https://littleinsomniac.com).
  apiKey: 'api_test_key'
});

Option 2: Install via CDN

Install with CDN if you plan to use Little Insomniac only in a browser environment.

<script src="https://cdn.jsdelivr.net/npm/little-insomniac@latest/dist/index.min.js"></script>
<script type="text/javascript">
  var little-insomniac = new Little Insomniac({
    // Not required, but having one removes limits (get your key at https://littleinsomniac.com).
    apiKey: 'api_test_Key'
  });
</script>

Option 3: Use without installation

You can use little-insomniac in a variety of ways that require no installation, such as curl in terminal/shell. See the Use without installation section below.

⚡️ Using Little Insomniac

After you have followed the install step, you can start using little-insomniac to prevent your computer from sleeping

For a more in-depth documentation of this library and the Little Insomniac service, please visit the official Little Insomniac website.

🔧 Use without installation

Use Little Insomniac with curl

# Standard
curl -X POST https://api.littleinsomniac.com

📝 What Can Little Insomniac do?

Little Insomniac is a free anti-sleep app that lets you prevent computer sleep on all of your devices!

🗨️ Final Words

If you are still having difficulty, we would love for you to post a question to the Little Insomniac issues page. It is much easier to answer questions that include your code and relevant files! So if you can provide them, we'd be extremely grateful (and more likely to help you find the answer!)

📚 Projects Using this Library

• coming soon!

Ask us to have your project listed! :)