Create your first Prog

Prerequisites

1. Installed Proggy CLI
2. A Proggy account

If you have not yet downloaded and installed the Proggy CLI, please refer to our Installation guide.

We will cover how you can register for a Proggy account in the next step.

Creating a new Prog

Type the following:

proggy new

This will open your browser and bring you to a page where you can define a new Proggy command.

Alternatively, you can click on My Progs and New from the web.

From this screen, you will need to enter a new command name. The name of this command must be unique to your account.

If you have multiple commands with the same name, a workaround is to namespace them. You can create command namespaces with the colon character, “:” (without quotations).

For example:

utils:maintenance

The last word will always be the command name, and anything preceding it will be the namespace. In the above example, the namespace is utils and the command name is maintenance.

This is useful for situations where it may be convenient to have the same command name but for different purposes (eg. different servers).

For example, let’s say you adminster multiple applications, and for each application there is a deployment command. You might then create multiple commands like so:

• app_1:deploy
• app_2:deploy
• …and so on…

You can nest multiple namespaces as well:

root_namespace:sub_namespace:command

In this above example, the sub_namespace is part of the root_namespace. It is not recommended to have too many levels of sub namespaces as it will make it difficult to keep track of things.

Proggy descriptions

Each Proggy should have its own, at the very minimum, a short description. The short description is used to describe a command whenever a user types proggy list (to display the list of available commands under their account).

A longer description can also be entered. The long description is only shown on the web.

Proggy visibility

By default, Proggyes are publicly viewable by anyone. Private Proggyes will be coming soon.

Directives

When you create a new Proggy, an initial “Display Text” directive is added. This directive acts merely as a placeholder. You can delete this directive you want and start adding your custom directives.

Once you have created your Prog, you are ready to run it!