reference.md

Castor reference

Here is a reference of all the functions and attributes provided by Castor.

Functions

Castor provides the following built-in functions:

• app
• cache
• capture
• context
• context_path
• exit_code
• finder
• fingerprint
• fingerprint_exists
• fingerprint_save
• fs
• get_cache
• guard_min_version
• hasher
• http_client
• import
• input
• io
• load_dot_env
• log
• logger
• notify
• output
• parallel
• request
• run
• ssh_download
• ssh_run
• ssh_upload
• task
• variable
• wait_for
• wait_for_docker_container
• wait_for_http_response
• wait_for_http_status
• wait_for_port
• wait_for_url
• watch
• with
• yaml_dump
• yaml_parse

Attributes

Castor provides the following attributes to register tasks, listener, etc:

• AsArgument
• AsContext
• AsContextGenerator
• AsListener
• AsOption
• AsSymfonyTask
• AsTask