playground is a command-line tool to quickly create and otherwise manage playgrounds - throwaway coding environments to isolate bugs, try proof of concepts, or try out ideas.
This tool puts all playgrounds into a directory called playgrounds, called a location. When called, it will look for the nearest location according to the following rules:
- If the current directory is called
playgrounds, the location is the current directory. - If the current directory directly contains a directory called
playgrounds, the location is that directory. - Otherwise, move up one level and repeat.
Creates a new playground with the provided name. Playground names must be valid Unix filenames. They must not contain /, ?, *, and in addition may not start with a .. Playground names may not contain interpolation sequences ({{ }}, see below).
Playgrounds are created from templates. During creation, all files in the template's directory are copied into the new playground. Symlinks pointing inside the template directory are changed after copy so they point inside the new playground. If no template is given, the default template is used.
File names and file contents may contain interpolation sequences: identifiers enclosed between {{ and }}. There may be an arbitrary amount of whitespace between the double braces and the actual identifier. Identifiers are replaces with values as follows:
| Identifier | Value |
|---|---|
playground |
The name of the new playground |
template |
The name of the template used to create the playground |
Options:
| Option | Meaning |
|---|---|
--template=TEMPLATE (-t TEMPLATE) |
The name of the template to use. If not given, the default template is used. |
Lists all playgrounds in this location.
Options:
None
Permanently deletes the playground with the given name.
Options:
None
Shows instructions about the use of the specified command. If no command is specified, gives an overview of all commands.
Options:
None
Displays the current playground location directory being used.
Options:
None
Creates a new template with the specified name. This command initializes a new template directory in the current playground location's templates folder. You can then add files or symlinks to customize the blueprint used when creating new playgrounds.
Options:
None
Lists all available templates in the current playground location. This command displays each template present in the templates directory.
Options:
None
Without an argument, displays the current default template used during playground creation. When a TEMPLATE argument is provided, it sets that template as the default, so future playgrounds will use it unless an alternative is specified.
Options:
None
Permanently deletes the specified template from the templates location. This action is irreversible and should be used with caution.
Options:
None
