Skip to content
This repository has been archived by the owner on Jul 22, 2023. It is now read-only.

Commit

Permalink
Update docs of each action to mention CLI call option (fastlane#14060)
Browse files Browse the repository at this point in the history
This will make it easier to know that you can use call every fastlane action from the CLI also

---

![screen shot 2019-01-14 at 11 29 06 am](https://user-images.githubusercontent.com/869950/51126089-45abfd00-17f0-11e9-9438-813770086310.png)
  • Loading branch information
KrauseFx authored Jan 14, 2019
1 parent 8346a84 commit bc1c472
Showing 1 changed file with 28 additions and 1 deletion.
29 changes: 28 additions & 1 deletion fastlane/lib/assets/ActionDetails.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -50,12 +50,39 @@ Key | Description | Default
<% end %><%# End of action.available_options... %>

<hr />

## Documentation

To show the documentation in your terminal, run
```no-highlight
fastlane action <%= action.action_name %>
```

<a href="https://github.com/fastlane/fastlane/blob/master/fastlane/lib/fastlane/actions/<%= @action_filename %>" target="_blank">View source code</a>
<hr />

## CLI

It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal

```no-highlight
fastlane run <%= @action.action_name %>
```

To pass parameters, make use of the `:` symbol, for example

```no-highlight
fastlane run <%= @action.action_name %> parameter1:"value1" parameter2:"value2"
```

It's important to note that the CLI supports primative 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 _fastlane_ actions you use to your `Fastfile`.

<hr />

## Source code

This action, just like the rest of _fastlane_, is fully open source, <a href="https://github.com/fastlane/fastlane/blob/master/fastlane/lib/fastlane/actions/<%= @action_filename %>" target="_blank">view the source code on GitHub</a>

<hr />

Expand Down

0 comments on commit bc1c472

Please sign in to comment.