Installation

Install the CLI globally with npm or pnpm:

npm install -g @web3marketlabs/cli

Then run:

w3m

What You Need

Node.js 20+

Install from nodejs.org or via nvm (macOS/Linux) / fnm (Windows).

Foundry (recommended)

Install via foundryup. Foundry is optional — w3m works without it for non-contract tasks, but you need it for compiling, testing, and deploying Solidity contracts.

curl -L https://foundry.paradigm.xyz | bash
foundryup

Install the CLI

The npm install -g command above provides the w3m command globally. Both w3m and web3market are available as aliases.

Interactive workspace

Running w3m with no arguments launches the interactive workspace. The menu adapts to your context:

Inside a project directory — Goes directly to the project workspace menu (works without auth)
Not in a project directory — Shows recent projects and options to create or open one

Add packages to an existing project

pnpm add @web3marketlabs/sdk @web3marketlabs/config @web3marketlabs/react
pnpm add -D @web3marketlabs/codegen @web3marketlabs/cli

Then create a kit.config.ts in your project root:

kit.config.ts

import { defineConfig } from '@web3marketlabs/config'
 
export default defineConfig({
  contracts: {
    framework: 'foundry',
  },
  chains: {
    default: 'sepolia',
  },
  components: [],
})

Authentication

Authentication is optional for local development. It is only required for deploying to testnets and mainnets.

Get your API key

Go to web3.market/dashboard/plan
Click New Key to generate an API key (format: wm_sk_live_xxx)
Authenticate via the CLI:

w3m auth wm_sk_live_your_key_here

⚠️

The ~/.web3market/credentials.json file contains sensitive credentials. Do not commit it to version control. It is created in your home directory, not in your project.

See the Authentication guide for full details.

Verify Installation

w3m --version

You should see the current version number (e.g. 0.3.0).

Next Steps

Continue to the Quickstart guide to build your first dApp.

Introduction Quickstart