package init

Aliases: 
  • init
    •  
    Parameters:
    Name Type Required Default Hint
    name string false My Package The human-readable name for this package
    slug string false my-package The ForgeBox or unique slug for this package (no spaces or special chars)
    version string false 0.0.0 The version for this package, please use semantic versioning - 0.0.0
    private boolean false false Mark your package as private, so that if it is published to ForgeBox, only you can see it.
    shortDescription string false A sweet package A short description for the package
    ignoreList boolean false true Add commonly ignored files to the package's ignore list
    location string false ForgeboxStorage Where the package is located
    type string false modules Type of package (modules, etc)
    endpointName string false Name of custom forgebox endpoint to use
    wizard boolean false false Run the init wizard, defaults to false

    Command Usage

    Initialize a package in the current directory by creating a default box.json file.
    If you pass a `--wizard` flag, then the command will give you a wizard to init a package

    init
    Init with a wizard
    init --wizard
    Pass in an arguments you want and a property in the box.json will be initialized with the
    same name as the argument name using the argument value.
    init name="My App" slug=myApp version=1.0.0.0