https://github.com/thescientist13/copy-dots

Quickly copy dot files (and more!) from another project into an existing project with a single command.
https://github.com/thescientist13/copy-dots

cli hacktoberfest nodejs utility

Last synced: 1 day ago
JSON representation

Quickly copy dot files (and more!) from another project into an existing project with a single command.

• Host: GitHub
• URL: https://github.com/thescientist13/copy-dots
• Owner: thescientist13
• License: mit
• Created: 2020-08-07T00:04:33.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-11-03T18:48:08.000Z (about 4 years ago)
• Last Synced: 2024-10-23T02:35:40.907Z (2 months ago)
• Topics: cli, hacktoberfest, nodejs, utility
• Language: JavaScript
• Homepage:
• Size: 1.94 MB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# copy-dots

[![GitHub release](https://img.shields.io/github/tag/thescientist13/copy-dots.svg)](https://github.com/thescientist13/copy-dots/tags)

![GitHub Actions status](https://github.com/thescientist13/copy-dots/workflows/Master%20Integration/badge.svg)

[![GitHub issues](https://img.shields.io/github/issues-pr-raw/thescientist13/copy-dots.svg)](https://github.com/thescientist13/copy-dots/issues)

[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/thescientist13/copy-dots/master/LICENSE.md)

## Overview

Quickly copy dot files (and more!) from one project into another project with a single command.  Great for scaffolding or initializing a new project!  🚀

![copy-dots](./.github/assets/dots.jpg)

## Demo

![copy-dots-demo](./.github/assets/copy-dots-demo.gif)

> _**Note**: by default **copy-dots** will ignore any filename with that contains `"git"` in it to avoid clobbering your local directory by accident.  Fear not!  You can enable support for this using our options (below 👇)!_

## Setup

Make sure to have [latest NodeJS LTS](https://nodejs.org/) installed.

## Usage

**copy-dots** has one required paramater, which is a path.  Additional options available to include other file types / patterns.

### Path (required)

**copy-dots** at least needs to know what path to copy your files from.

```sh

$ npx copy-dots ../../my-project

```

### Options

**copy-dots** also support the following options to copy additional files.

* `-r` Readme

* `-l` License (TODO) 

* `-g` git files like _.gitignore_ and _.gitattributes_ (no _.git/_ though!) (TODO)

* `-c` config files like _greenwood.config.js_ (TODO)

* `-w` Includes all the flags (TODO)

For example, the below would copy dot files and the README

```sh

$ npx copy-dots /path/to/directory -r

```