OpenWallet - Wallet as a service

OpenWallet CLI

A CLI to interact with the OpenWallet API.

With the OpenWallet CLI, you can:

• Interact with the OpenWallet CLI

Installation

macOS

The OpenWallet CLI is available on macOS via Homebrew:

brew install openweb3-io/openwallet

Windows

The OpenWallet CLI is available on Windows via the Scoop package manager:

scoop bucket add openwallet https://github.com/openweb3-io/scoop-openwallet.git
scoop install openwallet

Linux

The OpenWallet CLI is available on Linux via:

• The Snap Store: snap install openwallet
• The Arch User Repository (AUR): yay -S openwallet-cli
• For Ubuntu/Debian: get the deb package from our Github releases page
• For Fedora/CentOS: get the rpm package from our Github releases page

Pre-built executables

You can download and use our pre-built executables directly from our releases page, and use them as is without having to install anything.

1. Download and extract the tar.gz archive for your operating system.
2. Run the openwallet executable from the command line: ./openwallet help.

Note: you may need to allow execution by running chmod +x openwallet.

You can also put the binaries anywhere in your PATH so you can run the command from anywhere without needing to provide its full path. On macOS or Linux you can achieve this by moving the executable to /usr/local/bin or /usr/bin.

Usage

Installing the OpenWallet CLI provides access to the openwallet command.

openwallet [command]

# Run `openwallet help` for information about the available commands
openwallet help

# or add the `--help` flag to any command for a more detailed description and list of flags
openwallet [command] --help

Using the listen command

The listen command creates an on-the-fly publicly accessible URL for use when testing webhooks.

NOTE: You don't need a OpenWallet account when using the listen command.

The cli then acts as a proxy, forwarding any requests to the given local URL. This is useful for testing your webhook server locally without having to open a port or change any NAT configuration on your network.

Example:

openwallet listen http://localhost:8000/webhook/

Interacting with the OpenWallet server

# Set your Secret temporarily via the OPENWALLET_SECRET environment variable
export OPENWALLET_SECRET=<MY-SECRET>
# or to persistently store your auth token in a config file run
openwallet login # interactively configure your OpenWallet API credentials

# Create an Wallet with the name "Demo"
openwallet wallet create '{ "name": "demo" }'
# or pipe in some json
echo '{ "name": "demo" }' | openwallet wallet create
# or use the convenience cli flags
openwallet wallet create --data-name demo

# List Wallets
openwallet wallet list --limit 2 --cursor some_cursor 

Commands

The OpenWallet CLI supports the following commands:

Command	Description
login	Interactively configure your OpenWallet API credentials
wallet	List, create & modify wallets
authentication	Manage authentication tasks such as getting dashboard URLs
endpoint	List, create & modify endpoints
event-type	List, create & modify event types
verify	Verify the signature of a webhook message
listen	Forward webhook requests a local url
integration	List, create & modify integrations
import	Import data from a file to your OpenWallet Organization
export	Export data from your OpenWallet Organization to a file
open	Quickly open OpenWallet pages in your browser
completion	Generate completion script
version	Get the version of the OpenWallet CLI
help	Help about any command

Shell Completions

Shell completion scripts are provided for Bash, Zsh, fish, & PowerShell.

To generate a script for your shell type openwallet completion <SHELL NAME>.

For detailed instructions on configuring completions for your shell run openwallet completion --help.

Documentation

For a more information, checkout our API reference.

Development

Building the current commit

This project uses goreleaser.

1. Install go.
2. Install snapcraft.
3. Install goreleaser via the steps here.
4. Build current commit via goreleaser release --snapshot --skip-publish --rm-dist.