Community Script Submission Guidelines

The Community section allows Addigy Partners to contribute scripts to one another. When submitting a custom script to the Community, the script will be reviewed by the Addigy Community team before being published to the Community. If you have questions about the Addigy Community or submitting your script, please get in touch with us at community@addigy.com.

Submission Guidelines

Updated: October 31, 2024

Now accepting scripts using additional hashbangs.

Here are the guidelines used to approve or reject all custom script submissions:

1. The Name and Description fields should demonstrate the value the script will bring to other members of the community.
2. The description should cover the following functional areas:
   • What the script does, as well as all the requirements it needs to execute successfully
   • Types of output that may be received, along with the related meaning
   • Logging details, if applicable
3. Shebangs are restricted to the default presets provided in our product.
4. The description should include "Known Limitations," a list of requirements, and dependencies necessary for proper function. If there are no known limitations on the supported OSes, that may also be indicated. i.e., "Known Limitations: No known limitations."
5. Examples of known limitations:
   • The fact requires specific software installed on devices.
   • The fact requires certain utilities or features not present on particular versions of an OS.
   • The fact requires a particular account or connection to be configured or logged in.
6. The script should not upload or escrow data to other sites, locations, or servers outside of Addigy.
7. The script must not rely on settings or infrastructure unique to your organization.
8. The script can not contain hard-coded references to specific data that is known to change frequently. This includes but is not limited to macOS versions, hardware releases, and software versions.

Submitting Custom Scripts to the Community

1. Navigate to the Devices page and click the Manage button.
2. Click Manage >> Edit for the script you would like to submit to the community.
3. Click the Submit to Community button.
4. Agree to the Community Script Terms & Conditions.
5. After submitting the script, editing will become disabled. If approved, the script will immediately become available in the Community > Scripts section.

Note: If you do not see the Submit to Community button, please email community@addigy.com for information on joining us as a Community contributor.

Reporting Community Scripts

If you find a Community Script that does not meet these guidelines, please let us know by using the Report option at the bottom of the script's page.

The Addigy Community team will review your report and, if necessary, remove the script from the community and contact the author.