Ember Garden Documentation

We hope you find this documentation useful. If you have any questions, feel free to reach out to support@ember.garden.

Creating an Ember

Embers are jq scripts that you can use as a web form. To create a new Ember, go to ember.garden/new.

You can either write or paste a script into the text box, or you can upload a .jq file from your computer.

Ember Input

Many Embers have input of some kind. If you check the "Has Input" box on your Ember, anyone who runs it will be prompted to enter or upload some input for your Ember to process.

Sending input to your Ember is equivalent to writing to stdin when running jq on the command line.

If you don't want to be prompted for input when you run your Ember, uncheck "Has Input". This is equivalent to passing the --null-input command line flag to jq.

Sample Input

Adding Sample Input helps people who run your Ember know what format data is expected in.

To add sample input, go to your Ember's edit page and enter the sample input in the right hand column. You can only add sample input for Embers that have input, so if you don't see the "Sample Input" section, make sure the "Has Input" box is checked.

Sample input is pre-populated in the input box on the Run page, and is publicly visible (for public Embers).

Ember Output

Embers often output JSON, and so execution output is typically served with a MIME type of application/json.

If your Ember does not output JSON, as when you use the --raw-output argument for jq, you can check the "Raw Output" box on your Ember settings.

When Raw Output is selected, Ember output is served with the text/plain MIME type instead.

Variables

Some Embers use additional input variables. After you create an Ember, you can add variables. Anyone who runs the Ember will be prompted to enter a value for each variable listed on an Ember, in addition to the Ember's input, if applicable.

To add a variable to an Ember, go to the Ember's edit page, then enter the name for the new variable at the bottom of the variables list and click "Add Variable".

To make it easier for people to run your Ember, you can optionally add human-friendly labels for your variables. After you add a variable, you can click the "Edit Labels" button. This will take you to a page where you can add additional details for each variable. The additional properties you can add include:

  • Label: This text will be displayed on the Run page instead of the raw variable name.
  • Help Text: A longer form description for the variable, to be displayed on the Run page underneath the input.
  • Default Value: Text to pre-populate in the input on the Run page.

Visibility

You can optionally set your Ember to be public.

When you mark an Ember as public, anyone who knows the URL for your Ember will be able to run it without logging in.

People who can run your Embers will also be able to expand the "Code" section to view your Ember's code.

All Embers are private by default.