download
Download a file from a remote server (e.g. JSON file)
Specify the URL to download and get the content as a return value.
Automatically parses JSON into a Ruby data structure.
| download | |
|---|---|
| Supported platforms | mac, linux, windows |
| Author | @KrauseFx |
1 Example
data = download(url: "https://host.com/api.json")
Parameters
| Key | Description | Default |
|---|---|---|
url |
The URL that should be downloaded |
* = default value is dependent on the user's system
Lane Variables
Actions can communicate with each other using a shared hash lane_context, that can be accessed in other actions, plugins or your lanes: lane_context[SharedValues:XYZ]. The download action generates the following Lane Variables:
| SharedValue | Description |
|---|---|
SharedValues::DOWNLOAD_CONTENT |
The content of the file we just downloaded |
To get more information check the Lanes documentation.
Documentation
To show the documentation in your terminal, run
pantograph action download
CLI
It is recommended to add the above action into your Pantfile, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
pantograph run download
To pass parameters, make use of the : symbol, for example
pantograph run download parameter1:"value1" parameter2:"value2"
It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. param:"1,2,3"). Hashes are not currently supported.
It is recommended to add all pantograph actions you use to your Pantfile.
Source code
This action, just like the rest of pantograph, is fully open source, view the source code on GitHub