Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
calibre
Advanced tools
Readme
This repository contains Calibre’s APIs you can use to fetch and manage your monitoring data. The Command Line Client (CLI) is designed for simple tasks right from your terminal. We recommend using the Node.js API for more complex tasks and automation.
ℹ️ Please note: Using the APIs requires an active Calibre account (in trial or on a paid plan).
To install the latest version globally, run this command:
npm install -g calibre
or save it directly to your project:
npm install calibre --save
The calibre
package is built to support all current Node.js LTS releases.
To authenticate to Calibre and use the APIs, you will need to create or use an existing API Token. Learn about the types of API Tokens and how to create them here.
Once you have an API Token, you can store it locally:
calibre token set <your token>
Or alternately, set CALIBRE_API_TOKEN
environment variable.
--json
flag for machine-readable output.npm
package..To see a full list of available commands, subcommands and options run:
$ calibre --help
$ calibre <command> --help
or see all commands in this repository or Calibre’s documentation.
In Node, you can use the either ES Modules or CommonJS versions accordingly:
// ES Modules
import { Site } from 'calibre'
await Site.list()
// CommonJS
const { Site } = require('calibre')
await Site.list()
In addition to the named default exports shown above, the calibre
package also exports CLI related metadata, which is used to generate CLI documentation.
Each CLI command is a Node module that exports command
, describe
, handler
and builder
. You can import all CLI commands from calibre/cli-commands
(see src/cli.js
for reference).
import Commands from 'calibre/cli-commands'
You can import command metadata (used to generate CLI documentation) from the calibre/cli-metadata
export:
import { getCommandMetaData } from 'calibre/cli-metadata'
console.log(JSON.stringify(getCommandMetaData(), null, 2))
Happy to hear you’re interested in contributing to Calibre’s APIs! Please find our contribution guidelines here.
We prepared a handful of examples for common actions you might want to perform:
Find code examples and more information for the CLI and Node.js API in our documentation.
This project is MIT licensed.
FAQs
Calibre - Page speed performance testing with Google Lighthouse
The npm package calibre receives a total of 25,334 weekly downloads. As such, calibre popularity was classified as popular.
We found that calibre demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.