Quick Start Guide - Install and Run Testship in Minutes

Prerequisites

Before you begin, ensure you have:

• Node.js (v16 or higher)
• Rust and Solana CLI installed
• Anchor Framework installed
• An existing Anchor program or a new project ready

Installation

Quick Start with npx (Recommended)

Run Testship directly without installation using npx:

npx @blockchain-hq/testship@latest start

This ensures you’re always using the latest version without managing global installations.

Global Installation (Alternative)

Or install Testship globally:

# npm
npm install -g @blockchain-hq/testship

# yarn
yarn global add @blockchain-hq/testship

# pnpm
pnpm add -g @blockchain-hq/testship

📦 Package: @blockchain-hq/testship on npm

Getting Started

1. Navigate to Your Project

Navigate to your Anchor project directory:

cd your-anchor-project

2. Build Your Program

Make sure your program is built:

anchor build

3. Launch Testship

Start the Testship interactive UI:

# Using npx (recommended)
npx @blockchain-hq/testship@latest start

# Or if installed globally
testship start

This will:

• Analyze your Anchor program IDL
• Generate an interactive testing interface
• Open your browser at http://localhost:3000

4. Start Testing

The Testship UI will display:

• All available program instructions
• Automatically derived account inputs
• PDA derivation helpers
• Account suggestion dropdowns

Simply select an instruction, fill in the required parameters, and click “Execute” to test your program!

What’s Next?

Explore Testship’s powerful features:

• Interactive UI - Learn about the automatic UI generation
• PDA Derivation - Master automatic PDA calculations
• Account Suggestions - Utilize smart account suggestions
• Session Sharing - Share testing sessions with your team
• Hot Reloading - Experience seamless development workflow

Need Help?

• Visit testship.xyz for more resources
• Follow us on X @testshipxyz for updates
• Check out the package on npm
• Report issues on our GitHub repository