Skip to content

Commit

Permalink
deploy: 0798d4c
Browse files Browse the repository at this point in the history
  • Loading branch information
rsenden committed Sep 9, 2024
1 parent de14894 commit 6a9643a
Show file tree
Hide file tree
Showing 347 changed files with 51,074 additions and 2 deletions.
1 change: 1 addition & 0 deletions _data/versions/release.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
- 'v2.6.0'
- 'v2.5.3'
- 'v2.5.2'
- 'v2.5.1'
Expand Down
2 changes: 1 addition & 1 deletion dev-info.html
Original file line number Diff line number Diff line change
Expand Up @@ -863,7 +863,7 @@ <h3 id="_action_schema"><a class="anchor" href="#_action_schema"></a>Action sche
<div id="footer">
<div id="footer-text">
Version none<br>
Last updated 2024-09-09 12:18:16 UTC
Last updated 2024-09-09 12:37:24 UTC
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ <h2 id="_developer_documentation"><a class="anchor" href="#_developer_documentat
<div id="footer">
<div id="footer-text">
Version none<br>
Last updated 2024-09-09 12:18:16 UTC
Last updated 2024-09-09 12:37:24 UTC
</div>
</div>
</body>
Expand Down
1,454 changes: 1,454 additions & 0 deletions v2.6.0/index.html

Large diffs are not rendered by default.

126 changes: 126 additions & 0 deletions v2.6.0/manpage/fcli-config-clear.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,126 @@
---
title: fcli-config-clear(1)
fcli_version:
---

<!DOCTYPE html>
<html lang="">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=">
<meta name="generator" content="Asciidoctor 2.0.18">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>fcli-config-clear(1)</title>

{% include asciidoc-head.html %}

</head>
<body class="manpage toc2 toc-left">

{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.6.0" %}


<div id="header">
<h1>fcli-config-clear(1) Manual Page</h1>
<div id="toc" class="toc2">
<div id="toctitle">Table of Contents</div>
<ul class="sectlevel1">
<li><a href="#_synopsis">Synopsis</a></li>
<li><a href="#_description">Description</a></li>
<li><a href="#_options">Options</a></li>
<li><a href="#_output_options">Output options:</a></li>
<li><a href="#_generic_fcli_options">Generic fcli options:</a></li>
</ul>
</div>
<h2>Name</h2>
<div class="sectionbody">
<p>fcli-config-clear - Clear full fcli configuration.</p>
</div>
</div>
<div id="content">
<div class="sect1">
<h2 id="_synopsis"><a class="anchor" href="#_synopsis"></a>Synopsis</h2>
<div class="sectionbody">
<div class="paragraph">
<p><strong>fcli config clear</strong> [<strong>-y</strong>] [[<strong>-h</strong>] [<strong>--env-prefix</strong>=<em>&lt;envPrefix&gt;</em>] [<strong>--log-file</strong>=<em>&lt;logFile&gt;</em>]
[<strong>--log-level</strong>=<em>&lt;logLevel&gt;</em>]] <em class="[<strong>-o</strong>=_format[=&lt;options&gt;">]
[<strong>--store</strong>=_variableName[=&lt;propertyNames&gt;]</em>]
[<strong>--to-file</strong>=<em>&lt;outputFile&gt;</em>]]</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_description"><a class="anchor" href="#_description"></a>Description</h2>
<div class="sectionbody">
<div class="paragraph">
<p>This command deletes the fcli configuration directory, clearing configuration settings like language, proxy and trust store settings. Note that this does not clear current fcli state, like session and variable data; please use the 'fcli util state clear' command for clearing state data.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_options"><a class="anchor" href="#_options"></a>Options</h2>
<div class="sectionbody">
<div class="dlist">
<dl>
<dt class="hdlist1"><strong>-y</strong>, <strong>--confirm</strong></dt>
<dd>
<p>Confirm deleting all fcli configuration settings.</p>
</dd>
</dl>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_output_options"><a class="anchor" href="#_output_options"></a>Output options:</h2>
<div class="sectionbody">
<div class="dlist">
<dl>
<dt class="hdlist1"><strong>-o</strong>, <strong>--output</strong>=<em>format[=&lt;options&gt;]</em></dt>
<dd>
<p>Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.</p>
</dd>
<dt class="hdlist1"><strong>--store</strong>=<em>variableName[=&lt;propertyNames&gt;]</em></dt>
<dd>
<p>Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.</p>
</dd>
<dt class="hdlist1"><strong>--to-file</strong>=<em>&lt;outputFile&gt;</em></dt>
<dd>
<p>Write command output to the specified file instead of stdout.</p>
</dd>
</dl>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_generic_fcli_options"><a class="anchor" href="#_generic_fcli_options"></a>Generic fcli options:</h2>
<div class="sectionbody">
<div class="dlist">
<dl>
<dt class="hdlist1"><strong>--env-prefix</strong>=<em>&lt;envPrefix&gt;</em></dt>
<dd>
<p>Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.</p>
</dd>
<dt class="hdlist1"><strong>-h</strong>, <strong>--help</strong></dt>
<dd>
<p>Show this help message and exit. Use 'fcli &lt;command&gt; -h' to display help for subcommands.</p>
</dd>
<dt class="hdlist1"><strong>--log-file</strong>=<em>&lt;logFile&gt;</em></dt>
<dd>
<p>File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.</p>
</dd>
<dt class="hdlist1"><strong>--log-level</strong>=<em>&lt;logLevel&gt;</em></dt>
<dd>
<p>Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.</p>
</dd>
</dl>
</div>
</div>
</div>
</div>
<div id="footer">
<div id="footer-text">
Version <br>
Last updated 2024-09-09 12:39:12 UTC
</div>
</div>
</body>
</html>
168 changes: 168 additions & 0 deletions v2.6.0/manpage/fcli-config-proxy-add.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,168 @@
---
title: fcli-config-proxy-add(1)
fcli_version:
---

<!DOCTYPE html>
<html lang="">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=">
<meta name="generator" content="Asciidoctor 2.0.18">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>fcli-config-proxy-add(1)</title>

{% include asciidoc-head.html %}

</head>
<body class="manpage toc2 toc-left">

{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.6.0" %}


<div id="header">
<h1>fcli-config-proxy-add(1) Manual Page</h1>
<div id="toc" class="toc2">
<div id="toctitle">Table of Contents</div>
<ul class="sectlevel1">
<li><a href="#_synopsis">Synopsis</a></li>
<li><a href="#_description">Description</a></li>
<li><a href="#_options">Options</a></li>
<li><a href="#_output_options">Output options:</a></li>
<li><a href="#_generic_fcli_options">Generic fcli options:</a></li>
<li><a href="#_arguments">Arguments</a></li>
</ul>
</div>
<h2>Name</h2>
<div class="sectionbody">
<p>fcli-config-proxy-add - Add a proxy configuration.</p>
</div>
</div>
<div id="content">
<div class="sect1">
<h2 id="_synopsis"><a class="anchor" href="#_synopsis"></a>Synopsis</h2>
<div class="sectionbody">
<div class="paragraph">
<p><strong>fcli config proxy add</strong> [<strong>-p</strong>[=<em>&lt;proxyPassword&gt;</em>]] [<strong>--name</strong>=<em>&lt;name&gt;</em>]
[<strong>--priority</strong>=<em>&lt;priority&gt;</em>] [<strong>-u</strong>=<em>&lt;proxyUser&gt;</em>] [<strong>-m</strong>=<em>&lt;modules&gt;</em>[,
<em>&lt;modules&gt;</em>&#8230;&#8203;]]&#8230;&#8203; [[<strong>-h</strong>] [<strong>--env-prefix</strong>=<em>&lt;envPrefix&gt;</em>]
[<strong>--log-file</strong>=<em>&lt;logFile&gt;</em>] [<strong>--log-level</strong>=<em>&lt;logLevel&gt;</em>]]
<em class="[<strong>-o</strong>=_format[=&lt;options&gt;">] [<strong>--store</strong>=_variableName</em>
_ <em class="=&lt;propertyNames&gt;">] [<strong>--to-file</strong>=</em>&lt;outputFile&gt;_]]
[<strong>-i</strong>=<em>&lt;includedHosts&gt;</em>[,<em>&lt;includedHosts&gt;</em>&#8230;&#8203;]
[<strong>-i</strong>=<em>&lt;includedHosts&gt;</em>[,<em>&lt;includedHosts&gt;</em>&#8230;&#8203;]]&#8230;&#8203; |
<strong>-e</strong>=<em>&lt;excludedHosts&gt;</em>[,<em>&lt;excludedHosts&gt;</em>&#8230;&#8203;]
[<strong>-e</strong>=<em>&lt;excludedHosts&gt;</em>[,<em>&lt;excludedHosts&gt;</em>&#8230;&#8203;]]&#8230;&#8203;] <em>HOST:PORT</em></p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_description"><a class="anchor" href="#_description"></a>Description</h2>
<div class="sectionbody">

</div>
</div>
<div class="sect1">
<h2 id="_options"><a class="anchor" href="#_options"></a>Options</h2>
<div class="sectionbody">
<div class="dlist">
<dl>
<dt class="hdlist1"><strong>-e</strong>, <strong>--exclude-hosts</strong>=<em>&lt;excludedHosts&gt;</em>[,<em>&lt;excludedHosts&gt;</em>&#8230;&#8203;]</dt>
<dd>
<p>Comma-separated list of target host names on which not to apply this proxy configuration. Host names may include wildcard characters, like *.myintra.net.</p>
</dd>
<dt class="hdlist1"><strong>-i</strong>, <strong>--include-hosts</strong>=<em>&lt;includedHosts&gt;</em>[,<em>&lt;includedHosts&gt;</em>&#8230;&#8203;]</dt>
<dd>
<p>Comma-separated list of target host names on which to apply this proxy configuration. Host names may include wildcard characters, like *.fortifyhosted.net.</p>
</dd>
<dt class="hdlist1"><strong>-m</strong>, <strong>--modules</strong>=<em>&lt;modules&gt;</em>[,<em>&lt;modules&gt;</em>&#8230;&#8203;]</dt>
<dd>
<p>Comma-separated list of fcli modules / target systems (fod, sc-dast, sc-sast, ssc, debricked, tool) on which to apply this proxy configuration.</p>
</dd>
<dt class="hdlist1"><strong>--name</strong>=<em>&lt;name&gt;</em></dt>
<dd>
<p>Name for the proxy configuration to be added; defaults to &lt;proxy host&gt;:&lt;proxy port&gt;.</p>
</dd>
<dt class="hdlist1"><strong>-p</strong>, <strong>--password</strong>[=<em>&lt;proxyPassword&gt;</em>]</dt>
<dd>
<p>Password used to authenticate with the proxy server.</p>
</dd>
<dt class="hdlist1"><strong>--priority</strong>=<em>&lt;priority&gt;</em></dt>
<dd>
<p>Priority of this proxy configuration. If multiple configuration match the target module &amp; URL, the proxy configuration with highest priority is used.</p>
</dd>
<dt class="hdlist1"><strong>-u</strong>, <strong>--user</strong>=<em>&lt;proxyUser&gt;</em></dt>
<dd>
<p>Username used to authenticate with the proxy server.</p>
</dd>
</dl>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_output_options"><a class="anchor" href="#_output_options"></a>Output options:</h2>
<div class="sectionbody">
<div class="dlist">
<dl>
<dt class="hdlist1"><strong>-o</strong>, <strong>--output</strong>=<em>format[=&lt;options&gt;]</em></dt>
<dd>
<p>Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.</p>
</dd>
<dt class="hdlist1"><strong>--store</strong>=<em>variableName[=&lt;propertyNames&gt;]</em></dt>
<dd>
<p>Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.</p>
</dd>
<dt class="hdlist1"><strong>--to-file</strong>=<em>&lt;outputFile&gt;</em></dt>
<dd>
<p>Write command output to the specified file instead of stdout.</p>
</dd>
</dl>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_generic_fcli_options"><a class="anchor" href="#_generic_fcli_options"></a>Generic fcli options:</h2>
<div class="sectionbody">
<div class="dlist">
<dl>
<dt class="hdlist1"><strong>--env-prefix</strong>=<em>&lt;envPrefix&gt;</em></dt>
<dd>
<p>Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.</p>
</dd>
<dt class="hdlist1"><strong>-h</strong>, <strong>--help</strong></dt>
<dd>
<p>Show this help message and exit. Use 'fcli &lt;command&gt; -h' to display help for subcommands.</p>
</dd>
<dt class="hdlist1"><strong>--log-file</strong>=<em>&lt;logFile&gt;</em></dt>
<dd>
<p>File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.</p>
</dd>
<dt class="hdlist1"><strong>--log-level</strong>=<em>&lt;logLevel&gt;</em></dt>
<dd>
<p>Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.</p>
</dd>
</dl>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_arguments"><a class="anchor" href="#_arguments"></a>Arguments</h2>
<div class="sectionbody">
<div class="dlist">
<dl>
<dt class="hdlist1"><em>HOST:PORT</em></dt>
<dd>
<p>Proxy host and port in the format &lt;proxy host&gt;:&lt;proxy port&gt;.</p>
</dd>
</dl>
</div>
</div>
</div>
</div>
<div id="footer">
<div id="footer-text">
Version <br>
Last updated 2024-09-09 12:39:12 UTC
</div>
</div>
</body>
</html>
Loading

0 comments on commit 6a9643a

Please sign in to comment.