Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 53 additions & 12 deletions docs/Agent-Wallet/QuickStart.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,58 @@ import TabItem from '@theme/TabItem';

# Quick Start

Three steps, from zero to invoking your Agent-wallet in the OpenClaw chat box. No coding required, no gas fees — just copy and paste.
From zero to invoking your Agent-wallet in your AI agent chat. We provide two ways to create your wallet — **conversational setup is the easiest**, done entirely from your AI chat; **command-line setup** gives you the most precise control.

:::tip Want CLI command details?
This page only walks you through the shortest path. For password-free configuration, managing multiple wallets, signature types, and other advanced topics, see the [CLI Reference](./Developer/CLI-Reference.md).
:::tip Prerequisites & CLI command details
- Your AI Agent supports shell command execution (OpenClaw, a Telegram bot, web chat, Claude Code, Cursor, etc.)
- This page only walks you through the shortest path. For password-free configuration, managing multiple wallets, signature types, and other advanced topics, see the [CLI Reference](./Developer/CLI-Reference.md).
:::

---

## Step 1: Install and Initialize Your Wallet
## Method 1: Conversational Setup (Easiest)

### 1.1 Prepare Your Environment: Install Node.js
If you've already installed [the BANK OF AI skill suite](../McpServer-Skills/SKILLS/QuickStart.md) (which includes `agent-wallet` and `bankofai-guide`), creating a wallet takes just one prompt in your AI chat — the AI generates the password, creates the wallet, and saves the config for you, with no manual file editing.

**How it works:**

1. Open your AI Agent chat
2. Copy and paste the following prompt:

```
Create an AgentWallet
```

3. The AI handles the entire flow automatically:
- **Checks current wallet status** — tells you whether one is already configured
- **Asks how to create it** — offers two options:
- **A. Quick setup (highly recommended)**: fully automated, ~10 seconds; auto-generates a secure password; encrypted wallet stored locally
- **B. Detailed setup**: manually pick wallet type; custom password; more configuration options
4. Reply `A` and the AI runs the three setup steps automatically:
- **Step 1**: Generate a secure password
- **Step 2**: Create the wallet
- **Step 3**: Retrieve the wallet addresses


:::caution Your master password is critical — back it up immediately
The master password is only shown once. Although it is auto-saved to `~/.agent-wallet/runtime_secrets.json`, you should also save it manually to a password manager (1Password, Bitwarden, etc.). If the local file is lost or corrupted and you have no external backup, your wallet will be permanently locked — there is no recovery mechanism, no support team, and no backdoor.

⚠️ Never share this password via chat, email, screenshots, or public repositories.
:::

:::tip Done — no env-var configuration needed
Conversational setup auto-saves the password to `~/.agent-wallet/runtime_secrets.json`, and your AI Agent reads it automatically when calling wallet functions. **You don't need to manually export `AGENT_WALLET_PASSWORD`.** If you'd rather use the env-var approach, see Method 2 below.
:::

---

## Method 2: Command-Line Setup (Most Control)

If you want to control every step yourself, or your environment doesn't support conversational install, follow the command-line flow below.

### Step 1: Install and Initialize Your Wallet

#### 1.1 Prepare Your Environment: Install Node.js

Agent-wallet requires Node.js (a runtime environment, version >= 20) on your computer.

Expand Down Expand Up @@ -42,7 +83,7 @@ nvm install 20 && nvm use 20

</details>

### 1.2 Install Agent-wallet
#### 1.2 Install Agent-wallet

```bash
npm install -g @bankofai/agent-wallet
Expand All @@ -55,7 +96,7 @@ agent-wallet --help

If you see the help output, you're good to go.

### 1.3 Create Your Agent-wallet Wallet
#### 1.3 Create Your Agent-wallet Wallet

Run:
```bash
Expand Down Expand Up @@ -95,11 +136,11 @@ Do this right now:

---

## Step 2: Feed the Password to Your AI (Critical!)
### Step 2: Feed the Password to Your AI (Critical!)

For OpenClaw to automatically use your wallet, you must configure the password in its runtime environment. Select the tab matching your operating system and **just copy-paste**:
For your AI agent to automatically use your wallet, you must configure the password in its runtime environment. Select the tab matching your operating system and **just copy-paste**:

### 2.1 Save and Activate the Password
#### 2.1 Save and Activate the Password

<Tabs>
<TabItem value="mac" label="Mac Users (Zsh)" default>
Expand Down Expand Up @@ -167,13 +208,13 @@ export AGENT_WALLET_PASSWORD="P@ss$w0rd!" # actual value becomes "P@ss!"
```
:::

### 2.2 Restart Your AI Backend Service
#### 2.2 Restart Your AI Backend Service

:::danger Many people forget this step, then wonder why AI can't find the password!
You just saved a new password, but the AI assistant running in the background hasn't refreshed yet — it's still blind to the change! You need to shut it down and restart it for the new password to take effect.
:::

Whether or not you currently have the OpenClaw backend service running, make sure to **shut it down**, then **restart it** from the same terminal window where you ran the commands above.
Whether or not you currently have your AI agent backend service running, make sure to **shut it down**, then **restart it** from the same terminal window where you ran the commands above.

---

Expand Down
Loading
Loading