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

@proca/cli

v3.4.5

Published

cli[ent] for Proca

Downloads

21

Readme

   ,,\\\\\\,,
  ,\\\\\\\\\\\
 ▲▲▲▲▲▲\\\\\\\\  FIX THE STATUS QUO 
▲▲▲▲▲▲▲▲\\\\\\`
▼▼▼▼▼▼▼▼\\\\\`
 ▼▼▼▼▼▼`^^``

** This is a legacy tool, for 99% of the cases, you should either use the python cli or the cli tools from the widget builder](https://github.com/fixthestatusquo/proca) **

Proca CLI[ent]

Library and CLI tool for querying Proca GraphQL API.

Installation

it needs a recent version of nodejs installed (that will install npm too). Follow the specific instructions for your operating system

npm install --global proca_cli

Usage

Setup

Proca CLI needs connection configuration, which is:

  • url of proca backend
  • org name you're connecting to
  • user email
  • user password

You can provide these attributes as:

  • .env file, in dotfile format
  • environment variables (same as in .env file)
  • command line switches

Environment variables are:

ORG_NAME=someorg
[email protected]
AUTH_PASSWORD=secret123
API_URL=https://api.proca.app
KEYS=keys.json

Keys are sto is also allowedred in a JSON (map of public to private keys in base64url format). The format printed by proca-cli keys

You can run proca-cli setup to create or update .env file interactively. At the moment only one keypair is supported.

Commands

Common options:

  • -X - CSV output
  • -J - JSON output

setup - creates .env file with configuration variables

token - show authorization header used

campaigns - list campaigns

campaign -c id - gets info about campaign

pages - lists action pages

page -c id - gets info about action page

page:set -c id - sets info in action page

export - exports actions.

  • -i campaignId - just export for this campaign
  • -b number - batch size
  • -s start - start from id
  • -t stop - stop at id
  • -a date_time - actions created after (greater-equal) date_time (json format)
  • -e date_time - actions created before (less-then) date_time

Library usage

You can use this package as library, with:

import {api, crypto} from 'proca_cli'

First, create a client object:

const c = api.client({api: "https://api.proca.foundation", user: '[email protected]', password: 'qwerty1234'})

Methods accept client as first paramter, and are async:

api.campaigns(client, org) - fetch campaign list for client

api.streamSignatures(client, org, campaignId, callback) - downloads signatures for campaign campaignId and call callback({publicKey: "source-public-key", list: [....]}) with proca server public key, and list of supporter data (contacts encrypted).

To decrypt such stream pass {publicKey, list} to crypto.decryptSignatures method, which will return a list of supporter data with contact decrypted and JSON.parsed.