Roboflow.js

A JavaScript package for the Roboflow API.

API Key

Read the Roboflow documentation on instructions for obtaining an API key.

Usage

Install:

npm install --save @garyblackwood/roboflow.js

Use:

import { RoboflowClient } from "@garyblackwood/roboflow.js";

const roboflow = new RoboflowClient(process.env.ROBOFLOW_API_KEY);

const status = await roboflow.root();
console.log(status);

const workspace = await roboflow.workspace("my-workspace");
console.log(workspace);

const project = await roboflow.project("my-workspace", "my-project");
console.log(project);

const version = await roboflow.version("my-workspace", "my-project", 1);
console.log(version);

const format = await roboflow.format(
  "my-workspace",
  "my-project",
  1,
  "yolov5pytorch"
);
console.log(format);

Development Quick Start

Install dependencies:

npm install

Build:

npm run build

Run unit tests:

# Populate `ROBOFLOW_API_KEY` in `.env.example` and rename the file to `.env`.
npm run test

Lint the code:

npm run lint