npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

circle-cli-api

v0.3.0

Published

access the CircleCI API directly

Downloads

6

Readme

API Plugin for CircleCI CLI Circle CI

npm version

How to install this plugin

$ circle plugins:install circle-cli-api

Usage

$ circle api [--version VERSION] METHOD PATH

The api command is a convenient but low-level way to send requests to the CircleCI API. It sends an HTTP request to the CircleCI API using the given method on the given path. For methods PUT, PATCH, and POST, it uses stdin unmodified as the request body. It prints the response unmodified on stdout.

Method name input will be up-cased, so both 'circle api GET /apps' and 'circle api get /apps' are valid commands.

Examples:

  $ circle api GET /projects
  [ {
    "vcs_url": "https://github.com/circleci/mongofinil",
    "followed": true, // true if you follow this project in CircleCI
    "username": "circleci",
    "reponame": "mongofinil",
    "branches" : {
      "master" : {
        "pusher_logins" : [ "pbiggar", "arohner" ], // users who have pushed
        "last_non_success" : { // last failed build on this branch
          "pushed_at" : "2013-02-12T21:33:14Z",
          "vcs_revision" : "1d231626ba1d2838e599c5c598d28e2306ad4e48",
          "build_num" : 22,
          "outcome" : "failed",
          },
        "last_success" : { // last successful build on this branch
          "pushed_at" : "2012-08-09T03:59:53Z",
          "vcs_revision" : "384211bbe72b2a22997116a78788117b3922d570",
          "build_num" : 15,
          "outcome" : "success",
          },
        "recent_builds" : [ { // last 5 builds, ordered by pushed_at (decreasing)
          "pushed_at" : "2013-02-12T21:33:14Z",
          "vcs_revision" : "1d231626ba1d2838e599c5c598d28e2306ad4e48",
          "build_num" : 22,
          "outcome" : "failed",
          }, {
          "pushed_at" : "2013-02-11T03:09:54Z",
          "vcs_revision" : "0553ba86b35a97e22ead78b0d568f6a7c79b838d",

          "build_num" : 21,
          "outcome" : "failed",
          }, ... ],
        "running_builds" : [ ] // currently running builds
      }
    }
  }, ... ]

  $ circle api -v 2 /projects
  # Something different

  $ export CIRCLE_HEADERS
  $ CIRCLE_HEADERS='
  Content-Type: application/x-www-form-urlencoded
  Accept: application/json
  '
  $ printf 'type=web&qty=2' | circle api POST /apps/myapp/ps/scale
  2