1.2.4 • Published 10 months ago

@coderjamie/coldstart v1.2.4

Weekly downloads
-
License
MIT
Repository
-
Last release
10 months ago

Coldstart

Coldstart is a command-line tool that simplifies the process of cloning and setting up Git repositories. It automates the process of cloning a repository, with options to remove Git-related files, initialize a new Git repository, and install dependencies.

Features

  • Clone any Git repository
  • Remove Git-related files and directories (.git, .gitmodules) while preserving .gitignore
  • Optionally keep all Git-related files
  • Optionally initialize a new Git repository
  • Optionally install npm dependencies if package.json is present
  • Flexible directory naming

Installation

Prerequisites

  • Node.js (version 12 or higher)
  • npm (usually comes with Node.js)
  • Git

Global Installation

To install Coldstart globally, run:

npm install -g @coderjamie/coldstart

Local Installation

If you prefer to install it locally in your project:

npm install @coderjamie/coldstart

Usage

Basic Usage

coldstart <repository-url> [target-directory] [options]
  • <repository-url>: The URL of the Git repository you want to clone (required)
  • [target-directory]: The directory where you want to clone the repository (optional)

If no target directory is specified, Coldstart will use the repository name as the directory name.

Options

  • --keep-git-files: Keep the original Git-related files (.git, .gitignore, .gitmodules)
  • --init-git: Initialize a new Git repository after cloning
  • --install-deps: Automatically install npm dependencies if a package.json file is present

Examples

  1. Clone a repository into a new directory:

    coldstart https://github.com/username/repo.git my-new-project
  2. Clone a repository, initialize a new repo, and install dependencies:

    coldstart https://github.com/username/repo.git --init-git --install-deps
  3. Clone a repository and only initialize a new Git repo:

    coldstart https://github.com/username/repo.git --init-git

What it does

  1. Clones the specified Git repository
  2. Removes Git-related files (unless --keep-git-files is used)
  3. Optionally initializes a new Git repository (if --init-git is used)
  4. Optionally installs npm dependencies if a package.json file is present (if --install-deps is used)

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

MIT License

Issues

If you encounter any problems or have suggestions for improvements, please open an issue on the GitHub repository.

1.2.4

10 months ago

1.2.3

10 months ago

1.2.2

10 months ago

1.2.1

10 months ago

1.2.0

10 months ago

1.1.0

10 months ago

1.0.0

10 months ago