# <%= @action.action_name %>
<% action = @action %>
<%= action.description %>
<%= "> #{action.deprecated_notes.gsub("\n", "
")}" unless action.deprecated_notes.to_s.empty? %>
<% if @custom_content %>
<%= @custom_content %>
<% else %>
<%= "> #{action.details.gsub(/(?").gsub(/\|(?=\n|$)/, "")}" unless action.details.to_s.empty? %>
<% end %>
<%= action.action_name %> ||
---|---
Supported platforms | <%= [:ios, :android, :mac].find_all { |a| action.is_supported?(a) }.join(", ") %>
Author | @<%= Array(action.author || action.authors).join(", @") %>
<%- unless action.return_value.to_s.empty? -%>
Returns | <%= action.return_value.gsub("\n", "
") %>
<%- end -%>
<% if (action.example_code || []).count > 0 %>
## <%= action.example_code.count %> Example<%= (action.example_code.count > 1) ? "s" : "" %>
<% action.example_code.each do |current_sample| %>
```ruby
<%= current_sample.gsub(" ", "") %>
```
<% end %><%# End of action.example_code... %>
<% end %><%# End of if %>
<% if action.available_options && action.available_options.first.kind_of?(FastlaneCore::ConfigItem) %>
## Parameters
Key | Description | Default
----|-------------|--------
<%- (action.available_options || []).each do |config_item| -%>
<%- next unless config_item.kind_of?(FastlaneCore::ConfigItem) -%>
<%- next if config_item.description.to_s.length == 0 -%>
`<%= config_item.key %>` | <%= config_item.description.gsub(/(? | <%= config_item.doc_default_value %>
<%- end %>
* = default value is dependent on the user's system
<% end %><%# End of action.available_options... %>
## Documentation
To show the documentation in your terminal, run
```no-highlight
fastlane action <%= action.action_name %>
```
## 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 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 _fastlane_ actions you use to your `Fastfile`.
## Source code
This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
Back to actions