{"library":"circle-client","type":"library","category":null,"description":"The `circle-client` package provides a JavaScript and TypeScript client for interacting with the CircleCI v2 API. It allows developers to programmatically manage CI/CD pipelines, retrieve workflow and job insights, manage contexts and environment variables, and access user and project details. Currently at version `0.2.4`, the library is in a pre-1.0 development phase, which implies that minor versions may introduce breaking changes. It ships with comprehensive TypeScript definitions, offering a strongly-typed interface for API interactions, which significantly enhances developer experience and reduces common API-related errors. Key differentiators include its direct mapping of CircleCI v2 API endpoints to client methods, simplified handling of paginated results through a `Paged<T>` object, and a focus on abstracting the underlying HTTP request complexities, making it easier to integrate CircleCI operations into Node.js applications.","language":"javascript","status":"active","version":"0.2.4","tags":["javascript","circleci","circle","api","client","ci","cd","rest","typescript"],"last_verified":"Wed May 27","install":[{"cmd":"npm install circle-client","imports":["import CircleCI from 'circle-client';","import CircleCI, { Paged, Workflow, Pipeline } from 'circle-client';","import CircleCI from 'circle-client';\nconst client = new CircleCI(token, { slug: ['github', 'owner', 'repo'], branch: 'main' });"]},{"cmd":"yarn add circle-client","imports":[]},{"cmd":"pnpm add circle-client","imports":[]}],"homepage":"https://circleci.com","github":"https://github.com/jodyheavener/circle-client","docs":null,"changelog":null,"pypi":null,"npm":"https://www.npmjs.com/package/circle-client","openapi_spec":null,"status_page":null,"smithery":null,"compatibility":{"summary":{"python_range":"18–22","success_rate":0,"avg_install_s":null,"avg_import_s":null,"wheel_type":null},"url":"https://checklist.day/v1/registry/circle-client/compatibility"}}