intro.adoc 1.4 KB

1234567891011121314151617181920212223
  1. [#args]
  2. = Introduction to Arguments
  3. Actions and commands that OliveTin runs, without arguments, are generally quite safe - only that command can be run, without modifications. However, many users need the flexibility to set options on that command - normally called command line arguments. In OliveTin, arguments are defined in a shell commands like `echo {{ message }}`, with a bit of extra configuration.
  4. Examples of valid argument names are `{{ personName }}`, `{{ customer_number }}` and `{{ ISBN11_code }}`.
  5. * a-z (case insensitive)
  6. * _ is allowed
  7. * numbers are allowed (argument names can also start with numbers)
  8. * all other characters are invalid for argument names.
  9. == What's Next?
  10. Now that you understand how arguments work, explore the different argument types and features:
  11. * xref:args/types.adoc[Argument types] - Learn about different input types (text, dropdown, checkbox, etc.)
  12. * xref:args/safety.adoc[Argument safety] - Understand how OliveTin keeps arguments safe
  13. * xref:args/suggestions.adoc[Argument suggestions] - Add dynamic suggestions to help users
  14. * xref:args/regex.adoc[Input validation with regex] - Validate user input with regular expressions
  15. * xref:args/env.adoc[Environment variables] - Use arguments to set environment variables
  16. * xref:args/templates.adoc[Templates] - Use Go templates in actions, including JSON encoding
  17. * xref:action_examples/intro.adoc[See examples] - View real-world examples using arguments