Skip to main content

Command Line Interface

Getting Started Guide​

Welcome to the Thirdwave Command Line Interface (CLI) Getting Started Guide! This guide will help you install and configure the Thirdwave CLI tool to interact with Thirdwave's API. Whether you are a developer or a non-technical user, these step-by-step instructions will guide you through the process.

What is the Thirdwave CLI?​

The Thirdwave CLI is a command-line tool designed to interact with Thirdwave's API. It allows you to manage configurations, look up EVM wallets, and perform various other tasks directly from your terminal. This tool simplifies the process of accessing and managing data related to blockchain wallets.

When to use the CLI tool vs other Thirdwave tools to access Wallet Intelligence?​

Thirdwave API: Best suited for developers who need to integrate Thirdwave's data directly into their applications or services. If you require high customization and control over the data, using the API directly is the best option.

Thirdwave CLI: Ideal for users who prefer working in a terminal environment. It offers quick access to Thirdwave's functionalities without the need for extensive coding. Use the CLI for quick lookups, managing configurations, or automating simple tasks.

Thirdwave SDK (Coming Soon): Will be perfect for developers who want an easier and more integrated way to work with Thirdwave's data within their codebase. The SDK will provide pre-built functions and methods, making integration smoother and faster.

Thirdwave Audience Explorer: A visual UX experience where you can upload a list of wallets and view a dashboard summarizing wallet insights for that cohort of wallets. This is ideal for non-technical users or anyone looking for an easy-to-use, visual interface to analyze wallet data.

Prerequisites​

Before installing the Thirdwave CLI, you need to have Homebrew and Node.js installed on your system.

Homebrew​

Homebrew is a package manager for macOS and Linux. If you don't have Homebrew installed, you can install it by following the instructions on Homebrew's official website.

Installation:

  1. Open a terminal window.

  2. Paste the following command and press Enter:

    /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

Node.js​

Node.js is a JavaScript runtime that allows you to run JavaScript code on your computer. To install Node.js using Homebrew, open a terminal window and run the following command:

brew install node@22

This command will install Node.js and npm (Node Package Manager), which is required to install the Thirdwave CLI.

Thirdwave CLI Installation​

Once you have Homebrew and Node.js installed, you can proceed with installing the Thirdwave CLI.

  1. Open a terminal window.
  2. Run the following command to install the Thirdwave CLI globally on your system:

npm install -g thirdwave

This command will fetch the Thirdwave CLI code from npm's registry and install it.

Configuration​

The Thirdwave CLI requires an API key to interact with the Thirdwave API. Follow these steps to obtain and configure your API key:

  1. Visit Thirdwave Developer Documentation.

  2. You can obtain a key for free by registering an account on our platform and generating an API key in your account settings.

  3. Once you have your API Key, open a terminal window and run the following command to initialize the configuration:

    thirdwave config init

  4. You will be prompted to enter your API key. Fetch the API key from your account settings page and enter it into the prompt.

Basic Commands​

General Usage​

The Thirdwave CLI has several commands that you can use to interact with the API. Below are some of the most commonly used commands.

thirdwave [COMMAND]

Available Commands and Topics

  • config: Manage configuration values.
  • wallets: Look up EVM wallets.
  • autocomplete: Display autocomplete installation instructions.
  • help: Display help for Thirdwave CLI.
  • update: Update the Thirdwave CLI.
  • version: Check the current version.

Using the Wallets Command​

The wallets command allows you to look up information about EVM wallets. Below are some examples of how to use this command.

Basic Wallet Lookup​

thirdwave wallets 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045

Lookup with CSV Format​

thirdwave wallets --format=csv 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045 0x588031347beaa0d43978bc8c0094138a67d1a071

Lookup with JSON Format​

thirdwave wallets --format=json 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045 0x588031347beaa0d43978bc8c0094138a67d1a071

Batch Lookup from a File​

You can also perform a batch lookup of multiple wallet addresses by piping input from a file.

cat wallets.txt | thirdwave wallets

Troubleshooting and Help​

Common Issues

  • Issue: Command not found.
    • Solution: Ensure you have installed Node.js and npm correctly. Check your PATH environment variable.
  • Issue: Invalid API key.
    • Solution: Double-check the API key entered during the thirdwave config init step. Generate a new key if necessary.

If you encounter any issues or need further assistance, you can use the help command to display detailed help information for any command.

thirdwave help

FAQs​

  • How do I update the Thirdwave CLI?
    • Run npm update -g thirdwave to update to the latest version.
  • Can I use the CLI on Windows?
    • Yes, the Thirdwave CLI is compatible with Windows. Ensure you have Node.js installed.

Contact and Support​

For additional support, please refer to the Thirdwave Developer Documentation or contact our support channel on Telegram: @ThirdwaveDevelopers.