Skip to content

[Delegation Toolkit] Update docs for CLI quickstart #2186

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AyushBherwani1998 merged 2 commits into from
Jul 30, 2025
Merged

[Delegation Toolkit] Update docs for CLI quickstart #2186

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7ad8f92
update CLI quickstart
AyushBherwani1998 Jul 29, 2025
70eb197
resolve review comments
AyushBherwani1998 Jul 30, 2025
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
20 changes: 12 additions & 8 deletions delegation-toolkit/get-started/cli-quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,17 @@ Upon installation, you'll be asked the following prompts:
❯ nextjs
vite-react
? Pick a template: (Use arrow keys)
❯ Basic Delegator app with NextJS
Experimental: Basic Gator app to try out ERC7715 Permissions
❯ MetaMask Smart Accounts Starter
MetaMask Smart Accounts & Delegation Starter
Experimental: ERC7715 Permissions starter
? Pick a package manager: (Use arrow keys)
❯ npm
yarn
pnpm
```

Once you've answered the prompts with the required configuration and selected a template, the CLI will create the project using the specified name and settings.
Once you've answered the prompts with the required configuration and selected a template, the CLI will create the
project using the specified name and settings.
See the following section to learn more about available CLI configurations.

## Options
Expand All @@ -46,14 +48,15 @@ The CLI provides the following options to display CLI details, and further custo
| `-v` or `--version` | Check the current version of the `@metamask/create-gator-app` CLI. |
| `-h` or `--help` | Display the available options. |
| `--skip-install` | Skip the installation of dependencies. |
| `--add-web3auth` | Add Web3Auth Embedded Wallet as a signer for the delegator account. <br/>Supported templates: <ul><li>Next.js starter</li><li> Vite React starter</li></ul> |
| `--add-llm-rules` | Add LLM rules for your IDE. Supported templates: <ul><li>Next.js ERC-7715 starter</li></ul> |
| `--add-web3auth` | Add [Web3Auth Embedded Wallet](https://web3auth.io/docs) as a signer for the delegator account.<br/>Supported templates:<br/>- MetaMask Smart Accounts Starter<br/>- MetaMask Smart Accounts & Delegation Starter |
| `--add-llm-rules` | Add LLM rules for your IDE. Supported in the Experimental: ERC7715 Permissions Starter template. |

## Examples

### Web3Auth configuration

To create a project that uses [Web3Auth](https://web3auth.io/docs/) Embedded Wallet as the signer for your delegator account, use the `--add-web3auth` option with `@metamask/create-gator-app`:
To create a project that uses [Web3Auth](https://web3auth.io/docs/) Embedded Wallet as the signer for your delegator
account, use the `--add-web3auth` option with `@metamask/create-gator-app`:

```bash
npx @metamask/create-gator-app --add-web3auth
Expand Down Expand Up @@ -89,5 +92,6 @@ Currently, only Cursor and Windsurf are supported.

| Template | Next.js | Vite React |
|----------------------------------------------------|---------|------------|
| Basic dapp with delegation and redeem flow | ✅ | ✅ |
| Experimental: Basic dapp with ERC-7715 permissions | ✅ | |
| MetaMask Smart Accounts Starter | ✅ | ✅ |
| MetaMask Smart Accounts &amp; Delegation Starter | ✅ | ✅ |
| Experimental: ERC7715 Permissions starter | ✅ | |
Loading