scaffold/README.md

# Scaffold

Utilitaire de génération d'arborescence de fichiers à partir de projets "modèles" distants/locaux.

## Installation

### À partir des sources

```
go install forge.cadoles.com/wpetit/scaffold/cmd/scaffold
```

### À partir des binaires

1. [Télécharger la dernière version du binaire correspondant à votre plateforme](https://forge.cadoles.com/wpetit/scaffold/releases) (dernière version stable: 0.0.2)
2. Extraire l'archive et place le binaire `bin/scaffold` dans votre `$PATH` (par exemple dans le répertoire `/usr/local/bin`)

## Usage

```
NAME:
   scaffold - generate/update directory tree from template

USAGE:
   scaffold [global options] command [command options] [arguments...]

COMMANDS:
   from, n  generate a new project from a given template url
   help, h  Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --help, -h  show help (default: false)
```

### Commandes

#### `from`

```
NAME:
   scaffold from - generate a new project from a given template url

USAGE:
   scaffold from [command options] <URL>

OPTIONS:
   --directory DIR, -d DIR   Set destination to DIR (default: "./")
   --manifest FILE, -m FILE  The scaffold manifest FILE (default: "scaffold.yml")
   --ignore value, -i value  Ignore files matching pattern (default: ".git", ".git/**", "./.git/**/*")
   --help, -h                show help (default: false)
```

## Documentation

- [Format du fichier `scaffold.yml`](./doc/scaffold_file_format.md)

## Licence

[GPL-3.0](./LICENSE)