Reown AppKit CLI

AppKit CLI is a command-line tool to fast download a funcionaly boilerplate example for Reown Web AppKit SDK.

Installation

To install this CLI tool globally for development, you can link it locally using the following commands.

Prerequisites

• Node.js (v14 or later)
• npm (v6 or later)

Clone the Repository

First, clone this repository to your local machine:

git clone https://github.com/reown-com/appkit-cli
cd appkit-cli

Local Installation

To test the CLI locally, use npm link. This allows you to run the CLI from any location on your machine.

npm install
sudo npm link

Usage

Once linked, you can use the CLI globally by running:

appkit-cli

Also you can run it directly:

npx appkit-cli

Example Commands

Provide examples of some paramaeters:

appkit-cli [project-name]

For example:

appkit-cli my-app
appkit-cli

Linking/Unlinking for Local Development

Linking

If you want to work on the CLI and test it locally without publishing, use npm link:

1. Navigate to the Project Directory:

   cd path/to/appkit-cli

2. Run npm link:

   sudo npm link

Unlinking

To remove the symlink and unlink the CLI, use:

sudo npm unlink -g

This will unregister the global command appkit-cli, but it won’t delete any files in your project directory.

Quick Demo

Screen.Recording.2024-11-08.at.7.49.53.PM.mov