# @vanajmoorthy/caddy

> Automated Git init

Latest version **1.1.0** (published 2020-06-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install @vanajmoorthy/caddy
pnpm add @vanajmoorthy/caddy
yarn add @vanajmoorthy/caddy
bun add @vanajmoorthy/caddy
```

Provides the command `caddy`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2020-06-04 |
| First published | 2020-05-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 12 |
| Unpacked size | 286.2 KB |
| Known vulnerabilities | 0 (+6 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Vanaj Moorthy |
| Maintainers | vanajmoorthy |
| Keywords | git init, git, automated |

## Links

- npm: https://www.npmjs.com/package/@vanajmoorthy/caddy
- Repository: https://github.com/vanajmoorthy/caddy
- Homepage: https://github.com/vanajmoorthy/caddy#readme
- Issues: https://github.com/vanajmoorthy/caddy/issues
- npm.io page: https://npm.io/package/@vanajmoorthy/caddy

## Dependencies (12)

- [clui](https://npm.io/package/clui.md) ^0.3.6
- [chalk](https://npm.io/package/chalk.md) ^3.0.0
- [clear](https://npm.io/package/clear.md) ^0.1.0
- [touch](https://npm.io/package/touch.md) ^3.1.0
- [figlet](https://npm.io/package/figlet.md) ^1.2.4
- [lodash](https://npm.io/package/lodash.md) ^4.17.15
- [inquirer](https://npm.io/package/inquirer.md) ^7.0.3
- [minimist](https://npm.io/package/minimist.md) ^1.2.5
- [simple-git](https://npm.io/package/simple-git.md) ^1.129.0
- [configstore](https://npm.io/package/configstore.md) ^5.0.0
- [@octokit/rest](https://npm.io/package/@octokit/rest.md) ^16.36.0
- [@octokit/auth-basic](https://npm.io/package/@octokit/auth-basic.md) ^1.3.0

## Recent versions

- 1.1.0 (latest) — 2020-06-04
- 1.0.0 — 2020-05-15

## README

# Caddy 🚗

## It's Git, init?

### Table of contents

1. [Intro](#intro)
2. [Installation](#installation)
3. [Running Caddy](#running-caddy)
4. [About the name](#about-the-name)
5. [Can I contribute?](#can-i-contribute)
6. [License](#license)

### Intro

Caddy is a super small npm package to make initialising repositories on GitHub much easier.

Without Caddy, initialising a repository takes at least X steps

1. Open GitHub in your browser and navigate to your profile.
2. Create a new repository.
3. Run `git init` in a folder on your laptop.
4. Stage your files.
5. Write a commit message.
6. Add your GitHub repo as a remote url.
7. Push your code.

Sounds tedious, doesn't it?
Well with Caddy all of that can be reduces to one friendly command.

(Caddy can also be found on [npm](https://www.npmjs.com/package/@vanajmoorthy/caddy))

### Installation

Install Caddy via npm using the command

`npm install @vanajmoorthy/caddy -g`

### Running Caddy

Caddy is super simple to run. Just type in Caddy in your terminal, provide your GitHub credentials, and let Caddy do the rest!

![caddy login page](screenshots/caddylogin.png)

Then you just input the your repo name and description.

![caddy name](screenshots/name.png)

_PS: Caddy even generates a custom .gitignore for you with the files of your choice!_

### About the name

**This is very stupid**

Caddies _support_ you. Just like this tool does.
And the first _automatic_ car ever released was a Cadillac, and this tool automates creating a GitHub repository for you.

To be entirely honest, I'm very up to name suggestions.

### Can I contribute?

I would absolutely love that! You can submit any pull requests you want, any added functionality or optimisation would be welcomed. I was also looking forward to bringing similar versions of Caddy to other native package managers, so any help with that would be great as well!

### License

Caddy lives under the MIT license

---
_Source: https://npm.io/package/@vanajmoorthy/caddy · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._