The following box.json properties provide basic information about what your package is.
Name of the package. Short, but descriptive.
package set name="Whiz Bang Module"package show name
The unique slug for this package. Cannot contain spaces or special characters. Can contain a hyphen. Use the
forgebox slugcheck command to see if this slug is already in use. This is what people will use when installing your package from ForgeBox.
package set slug="whiz-bang"package show slug
The semantic version of your package following the pattern
package set version=1.0.0.0000package show version
The name of the author of the module as a string.
package set author="Brad Wood <[email protected]>"package show author
Describes what this package is in a couple sentences. Save the dissertation for the
package set description="Install this module to add a bit of Whiz Bang to your app."package show description
A flag that designates if this package is a ForgeBox private package. ForgeBox private packages are not publicly accessible, but offer all the benefits of ForgeBox. Private packages will be a paid feature for ForgeBox Pro subscribers, though the feature is currently available to all users for free.
package set private=falsepackage show private