@proca/cli NPM

   ,,\\\\\\,,
  ,\\\\\\\\\\\
 ▲▲▲▲▲▲\\\\\\\\  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 CLIent

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
AUTH_USER=user@domain.com
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: 'me@lol.pe', 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.