https://github.com/freshlybrewedcode/unity-git-cli

A CLI for working with Unity and Git.
https://github.com/freshlybrewedcode/unity-git-cli

Last synced: 3 days ago
JSON representation

A CLI for working with Unity and Git.

• Host: GitHub
• URL: https://github.com/freshlybrewedcode/unity-git-cli
• Owner: FreshlyBrewedCode
• License: mit
• Created: 2021-05-21T09:46:54.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2021-05-22T16:17:15.000Z (over 3 years ago)
• Last Synced: 2024-11-06T03:17:32.401Z (8 days ago)
• Language: TypeScript
• Homepage:
• Size: 41 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
unity-git

=========

A CLI for working with Unity and Git. 

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)

[![Version](https://img.shields.io/npm/v/unity-git.svg)](https://npmjs.org/package/unity-git)

[![Downloads/week](https://img.shields.io/npm/dw/unity-git.svg)](https://npmjs.org/package/unity-git)

[![License](https://img.shields.io/npm/l/unity-git.svg)](https://github.com/FreshlyBrewedCode/unity-git-cli/blob/master/package.json)

`unity-git` is a simple CLI that simplifies the setup of git and git lfs for Unity projects. The CLI can be used with `npx` or installed globally using `npm install -g`.

To initialize a git repo with git lfs and matching .gitignore and .gitattributes open a terminal and run:

```

cd 

npx unity-git init

```

or install globally first:

```

npm install -g unity-git

unity-git init

```

Depending on your platform and setup you may have to run the command with elevated permissions:

```

sudo npx unity-git init

``` 

* [Usage](#usage)

* [Commands](#commands)

# Usage

```sh-session

$ npm install -g unity-git

$ unity-git COMMAND

running command...

$ unity-git (-v|--version|version)

unity-git/1.1.0 linux-x64 node-v12.22.1

$ unity-git --help [COMMAND]

USAGE

  $ unity-git COMMAND

...

```

# Commands

* [`unity-git help [COMMAND]`](#unity-git-help-command)

* [`unity-git init`](#unity-git-init)

## `unity-git help [COMMAND]`

display help for unity-git

```

USAGE

  $ unity-git help [COMMAND]

ARGUMENTS

  COMMAND  command to show help for

OPTIONS

  --all  see all commands in CLI

```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.2/src/commands/help.ts)_

## `unity-git init`

init a new git repository for your unity project.

```

USAGE

  $ unity-git init

EXAMPLE

  $ unity-git init

```

_See code: [src/commands/init.ts](https://github.com/FreshlyBrewedCode/unity-git-cli/blob/v1.1.0/src/commands/init.ts)_