onramp-docs-cli/README.md

CLI tool to set up Onramp documentation and integration in your project

# embedded-wallet-docs-cli

A CLI tool to set up Embedded Wallet documentation and integration in your project. Perfect for adding comprehensive Embedded Wallet documentation to your Next.js or React applications.

## Installation

```bash
npm install -g embedded-wallet-docs-cli
```

Or use with npx:

```bash
npx embedded-wallet-docs-cli
```

## Usage

### Interactive Setup

Run the interactive setup to configure everything:

```bash
npx embedded-wallet-setup
```

This will guide you through:
- Setting up documentation files
- Installing required dependencies  
- Creating environment template

### Manual Commands

```bash
# Set up documentation (creates doc/embedded-wallet/)
npx embedded-wallet-docs setup

# Set up with custom path
npx embedded-wallet-docs setup -p ./my-docs -f

# Install dependencies (@coinbase/cdp-sdk, dotenv, viem)
npx embedded-wallet-docs install

# Create environment template
npx embedded-wallet-docs env

# List available documentation
npx embedded-wallet-docs
```

## What Gets Created

### Documentation Structure
```
doc/embedded-wallet/
├── wallet/
│   ├── cors-configuration.md
│   ├── embedded-wallets.md
│   ├── overview.md
│   ├── quickstart.md
│   ├── react-components.md
│   ├── react-hooks.md
│   └── wagmi.md
└── examples/
```

### Dependencies Installed
- `@coinbase/cdp-sdk` - Embedded Wallet SDK
- `dotenv` - Environment configuration
- `viem` - Ethereum library
- `@types/node` (dev dependency)

### Environment Template
Creates `.env.local.example` with CDP configuration variables.

## Features

- **Complete Documentation**: All Embedded Wallet docs included
- **Dependency Management**: Installs required packages automatically
- **Environment Setup**: Creates template for CDP credentials
- **Flexible Paths**: Configure custom documentation directories
- **Interactive Setup**: Guided configuration process
- **Next.js Ready**: Optimized for Next.js projects

## API

### EmbeddedWalletDocs Class

```typescript
import { EmbeddedWalletDocs } from 'embedded-wallet-docs-cli';

const docs = new EmbeddedWalletDocs();

// Setup documentation
await docs.setupDocs({
  docsPath: './doc/embedded-wallet',
  force: true
});

// Install dependencies
await docs.installDependencies();

// Create environment template
await docs.createEnvTemplate();

// List documentation
await docs.listDocs();
```

## Use Cases

- **New Projects**: Bootstrap Embedded Wallet integration
- **Documentation**: Add comprehensive guides to existing projects
- **Team Onboarding**: Provide local documentation for developers
- **Offline Development**: Access docs without internet connection

## Included Documentation

- **Overview**: Introduction to Embedded Wallets
- **Quickstart**: Getting started guide
- **React Components**: UI component documentation
- **React Hooks**: Hook-based integration
- **Wagmi Integration**: Using with Wagmi library
- **CORS Configuration**: Cross-origin setup
- **Embedded Wallets**: Core wallet functionality

## License

MIT