npm package: @glaz-techfi/create-scratch
Description: Plugin to create scratch orgs and automatically install and push sources
Author: olirwin
Latest version: 0.8.0

create-scratch
==============

A SFDX Plugin to create custom scratch orgs and automatically install dependencies. 
Also allows pushing source to org after creation.

[![Version](https://img.shields.io/npm/v/create-scratch.svg)](https://npmjs.org/package/create-scratch)
[![CircleCI](https://circleci.com/gh/glaz-finance/create-scratch/tree/master.svg?style=shield)](https://circleci.com/gh/glaz-finance/create-scratch/tree/master)
[![Appveyor CI](https://ci.appveyor.com/api/projects/status/github/glaz-finance/create-scratch?branch=master&svg=true)](https://ci.appveyor.com/project/heroku/create-scratch/branch/master)
[![Codecov](https://codecov.io/gh/glaz-finance/create-scratch/branch/master/graph/badge.svg)](https://codecov.io/gh/glaz-finance/create-scratch)
[![Greenkeeper](https://badges.greenkeeper.io/glaz-finance/create-scratch.svg)](https://greenkeeper.io/)
[![Known Vulnerabilities](https://snyk.io/test/github/glaz-finance/create-scratch/badge.svg)](https://snyk.io/test/github/glaz-finance/create-scratch)
[![Downloads/week](https://img.shields.io/npm/dw/create-scratch.svg)](https://npmjs.org/package/create-scratch)
[![License](https://img.shields.io/npm/l/create-scratch.svg)](https://github.com/glaz-finance/create-scratch/blob/master/package.json)

<!-- toc -->

<!-- tocstop -->

<!-- tocstop -->
<!-- install -->
## Installation
```bash
$ npm install -g create-scratch
```
<!-- usage -->
```sh-session
$ npm install -g @glaz-techfi/create-scratch
$ sfdx COMMAND
running command...
$ sfdx (-v|--version|version)
@glaz-techfi/create-scratch/0.8.0 linux-x64 node-v16.17.0
$ sfdx --help [COMMAND]
USAGE
  $ sfdx COMMAND
...
```
<!-- usagestop -->
```sh-session
$ npm install -g create-scratch
$ sfdx COMMAND
running command...
$ sfdx (-v|--version|version)
create-scratch/0.5.0 win32-ia32 node-v14.17.0
$ sfdx --help [COMMAND]
USAGE
  $ sfdx COMMAND
...
```
<!-- usagestop -->
<!-- commands -->
* [`sfdx dev:config:init [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-devconfiginit---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
* [`sfdx dev:scratch:create [-n <string>] [-d <integer>] [-p] [-c <string>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-devscratchcreate--n-string--d-integer--p--c-string--v-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)

## `sfdx dev:config:init [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`

Initialises a configuration file for scratch org construction.

```
USAGE
  $ sfdx dev:config:init [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation
```

_See code: [src/commands/dev/config/init.ts](https://github.com/glaz-finance/create-scratch/blob/v0.8.0/src/commands/dev/config/init.ts)_

## `sfdx dev:scratch:create [-n <string>] [-d <integer>] [-p] [-c <string>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`

Create a custom scratch org and install the required packages for your projet. Is also able to automatically push sources to the org

```
USAGE
  $ sfdx dev:scratch:create [-n <string>] [-d <integer>] [-p] [-c <string>] [-v <string>] [-u <string>] [--apiversion 
  <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -c, --conf=conf                                                                   overrides default config file
  -d, --duration=duration                                                           duration of scratch org
  -n, --name=name                                                                   created scratch org name
  -p, --push                                                                        set to push local sources to org

  -u, --targetusername=targetusername                                               username or alias for the target
                                                                                    org; overrides default target org

  -v, --targetdevhubusername=targetdevhubusername                                   username or alias for the dev hub
                                                                                    org; overrides default dev hub org

  --apiversion=apiversion                                                           override the api version used for
                                                                                    api requests made by this command

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation
```

_See code: [src/commands/dev/scratch/create.ts](https://github.com/glaz-finance/create-scratch/blob/v0.8.0/src/commands/dev/scratch/create.ts)_
<!-- commandsstop -->
* [`sfdx scratch:create [-n <string>] [-d <integer>] [-p] [-f <string>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-scratchcreate--n-string--d-integer--p--f-string--v-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)

## `sfdx scratch:create [-n <string>] [-d <integer>] [-p] [-f <string>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`

Create a custom scratch org and install the required packages for your projet. Is also able to automatically push sources to the org

```
USAGE
  $ sfdx scratch:create [-n <string>] [-d <integer>] [-p] [-f <string>] [-v <string>] [-u <string>] [--apiversion 
  <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -d, --duration=duration                                                           duration of scratch org

  -f, --file=file                                                                   Set to give additionnal config file
                                                                                    (for package passwords for examples)

  -n, --name=name                                                                   created scratch org name

  -p, --push                                                                        Set to push local sources to org

  -u, --targetusername=targetusername                                               username or alias for the target
                                                                                    org; overrides default target org

  -v, --targetdevhubusername=targetdevhubusername                                   username or alias for the dev hub
                                                                                    org; overrides default dev hub org

  --apiversion=apiversion                                                           override the api version used for
                                                                                    api requests made by this command

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation
```

_See code: [src/commands/scratch/create.ts](https://github.com/glaz-finance/create-scratch/blob/v0.5.0/src/commands/scratch/create.ts)_
<!-- commandsstop -->
<!-- debugging-your-plugin -->