cli-web-cloner

A simple CLI tool to make your local web development project deployment a breeze.

Table of Contents

prerequisites

• Terminal
• Node.js
• NPM
• Vercel
• TransIp
  • How to create a personal API token
• Installation
• Usage
• Commands
  • test
  • init
  • link
  • list
  • build
  • pull
  • auth
    • login
    • logout
    • whoami
    • status
  • clone
  • transip
    • set-token
    • get-token
    • update-token
    • delete-token
  • domain
    • check
    • list
    • buy
  • Vercel Domain Subcommands
    • add
    • buy
    • inspect
    • list
    • move
    • remove
    • transfer
• License
• Acknowledgments

Prerequisites

A few things you need to have installed and set up before you can use this tool.

Terminal

The tool is a command-line tool, so you need to have a terminal to run it. You can use the terminal that comes with your operating system, or you can use a third-party terminal like Hyper. For more information on how to use the terminal, you can check out this tutorial.

Node.js

This tool is built with Node.js, so you need to have it installed on your system. You can download it from the official website. Follow the instructions on the official website to install it on your system.

NPM

npm is the package manager for Node.js. It comes with Node.js, so you don't need to install it separately.

Vercel

To use this tool the user needs to have a Vercel account. You can sign up for a free account on the Vercel website. This tool uses Vercel to deploy the project to the web.

TransIp

To use this tool the user needs to have a TransIp account. You can sign up for a free account on the TransIp website. For domain purchase and configuration for TransIp domains a user needs to create a personal API token.

How to create a personal API token

To create this token log in to the TransIp dashboard and navigate to the control panel > settings > API. There the user needs to enable the API status, after enabling the API status the user can create a personal API token. This can be done by going to the Access tokens section and creating a new 1 month valid token. ⚠️ Warning: This token is only valid for 1 month, after that the user needs to create a new token. And set the new token.

Installation

To install this tool, you can use the following command:

npm install -g cli-web-cloner

This will install the tool globally on your system, so you can use it from anywhere.

Usage

To use this tool, you can run the following command:

cloner

This will start the tool, and you will be asked to enter the URL of the website you want to clone.

Commands

The cloner CLI tool provides several commands to help you manage your web projects and domains. Below is a detailed guide on how to use each command.

1. test

This command checks if the CLI tool is working correctly.

• How to Use:
  1. Open your terminal.
  2. Type the following command and press Enter:

  cloner test

  3. You should see a message saying "Test successful".

2. init

This command sets up a new project for you.

• How to Use:
  1. Decide on a name for your project.
  2. Open your terminal.
  3. Type the following command, replacing <projectName> with your project name, and press Enter:

  cloner init <projectName>

  4. If you want to use a specific framework (like React or Vue), add -f <frameworkName> to the command.

3. link

This command links an existing project.

• How to Use:
  1. Open your terminal.
  2. Type the following command and press Enter:

  cloner link

  3. If you want to skip confirmation, add -y to the command.

4. list

This command lists all your projects.

• How to Use:
  1. Open your terminal.
  2. Type the following command and press Enter:

  cloner list

  3. If you want to update the list, add -u to the command.

5. build

This command builds your project, making it ready for deployment.

• How to Use:
  1. Open your terminal.
  2. Type the following command and press Enter:

  cloner build

  3. If you want to build for production, add -p to the command.

6. pull

This command pulls the latest version of your project.

• How to Use:
  1. Open your terminal.
  2. Type the following command and press Enter:

  cloner pull

7. auth

This command helps you manage your Vercel account authentication.

Subcommands:

• login

  • How to Use:
    1. Open your terminal.
    2. Type the following command, replacing <email> with your email address, and press Enter:

    cloner auth login <email>

• logout

  • How to Use:
    1. Open your terminal.
    2. Type the following command and press Enter:

    cloner auth logout

• whoami

  • How to Use:
    1. Open your terminal.
    2. Type the following command and press Enter:

    cloner auth whoami

• status

  • How to Use:
    1. Open your terminal.
    2. Type the following command and press Enter:

    cloner auth status

8. clone

This command clones a website project.

• How to Use:
  1. Open your terminal.
  2. Type the following command, replacing <projectName> with your project name, and press Enter:

  cloner clone <projectName>

9. transip

This command group helps you manage your Transip API token.

Subcommands:

• set-token

  • How to Use:
    1. Open your terminal.
    2. Type the following command, replacing <token> with your Transip API token, and press Enter:

    cloner transip set-token <token>

• get-token

  • How to Use:
    1. Open your terminal.
    2. Type the following command and press Enter:

    cloner transip get-token

• update-token

  • How to Use:
    1. Open your terminal.
    2. Type the following command, replacing <token> with your Transip API token, and press Enter:

    cloner transip update-token <token>

• delete-token

  • How to Use:
    1. Open your terminal.
    2. Type the following command and press Enter:

    cloner transip delete-token

10. domain

This command group helps you manage domains.

Subcommands:

• check

  • How to Use:
    1. Open your terminal.
    2. Type the following command, replacing <domain> with the domain name, and press Enter:

    cloner domain check <domain>

• list

  • How to Use:
    1. Open your terminal.
    2. Type the following command and press Enter:

    cloner domain list

• buy

  • How to Use:
    1. Open your terminal.
    2. Type the following command, replacing <domain> with the domain name, and press Enter:

    cloner domain buy <domain>

Vercel Domain Subcommands:

• add

  • How to Use:
    1. Open your terminal.
    2. Type the following command, replacing <domain> and <project> with the domain and project names, and press Enter:

    cloner domain vercel add <domain> <project>

• buy

  • How to Use:
    1. Open your terminal.
    2. Type the following command, replacing <domain> with the domain name, and press Enter:

    cloner domain vercel buy <domain>

• inspect

  • How to Use:
    1. Open your terminal.
    2. Type the following command, replacing <domain> with the domain name, and press Enter:

    cloner domain vercel inspect <domain>

• list

  • How to Use:
    1. Open your terminal.
    2. Type the following command and press Enter:

    cloner domain vercel list

• move

  • How to Use:
    1. Open your terminal.
    2. Type the following command, replacing <domain> and <scopeName> with the domain name and scope name, and press Enter:

    cloner domain vercel move <domain> <scopeName>

• remove

  • How to Use:
    1. Open your terminal.
    2. Type the following command, replacing <domain> with the domain name, and press Enter:

    cloner domain vercel remove <domain>

• transfer

  • How to Use:
    1. Open your terminal.
    2. Type the following command, replacing <domain> with the domain name, and press Enter:

    cloner domain vercel transfer <domain>

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Acknowledgments

• Vercel
• TransIp
• Node.js
• NPM

Author

• Joeri Schenk
• GitHub