<p>Prior to this pull request, Bisq's <code>--help</code> output looked like this:</p>
<pre><code>$ bisq-desktop --help
Option Description
------ -----------
--appDataDir <String> Application data directory (default:
/Users/cbeams/Library/Application
Support/Bisq)
--appName <String> Application name (default: Bisq)
--banList <String> Nodes to exclude from network
connections. (default: )
--baseCurrencyNetwork <String> Base currency network (default:
BTC_MAINNET)
--bitcoinRegtestHost <RegTestHost> (default: LOCALHOST)
--btcNodes <String> Custom nodes used for BitcoinJ as
comma separated IP addresses.
(default: )
[...]
</code></pre>
<p>Now it reads as follows:</p>
<pre><code>$ bisq-desktop --help
Bisq Desktop version 0.8.0
Usage: bisq-desktop [options]
Options:
--help
This help text
--logLevel=<OFF|ALL|ERROR|WARN|INFO|DEBUG|TRACE> (default: INFO)
Log level
--seedNodes=<host:port[,...]>
Override hard coded seed nodes as comma separated list e.g.
'rxdkppp3vicnbgqt.onion:8002,mfla72c4igh5ta2t.onion:8002'
--myAddress=<host:port>
My own onion address (used for bootstrap nodes to exclude itself)
--banList=<host:port[,...]>
Nodes to exclude from network connections.
--nodePort=<Integer> (default: 9999)
Port to listen on
--useLocalhostForP2P=<Boolean> (default: false)
Use localhost P2P network for development
[...]
</code></pre>
<p>This new help format is modeled after bitcoind's own help output, which reads as follows:</p>
<pre><code>$ bitcoind --help | head -20
Bitcoin Core Daemon version v0.17.0.0-ge1ed37edaedc85b8c3468bd9a726046344036243
Usage: bitcoind [options] Start Bitcoin Core Daemon
Options:
-?
Print this help message and exit
-alertnotify=<cmd>
Execute command when a relevant alert is received or we see a really
long fork (%s in cmd is replaced by message)
-assumevalid=<hex>
If this block is in the chain assume that it and its ancestors are valid
and potentially skip their script verification (0 to verify all,
default:
0000000000000000002e63058c023a9a1de233554f28c7b21380b6c9003f36a8,
testnet:
0000000000000037a8cd3e06cd5edbfe9dd1dbcc5dacab279376ef7cfc2b4c75)
[...]
</code></pre>
<p>The goal is to maximize readibility, make best use of the available 80-character width and to present Bisq's command line interface in a way that is friendly and familiar to those well-versed in *nix idioms.</p>
<p>Reviewers, please look through the commits one-by-one and read the detailed commit comments, thanks.</p>
<hr>
<h4>You can view, comment on, or merge this pull request online at:</h4>
<p> <a href='https://github.com/bisq-network/bisq/pull/1961'>https://github.com/bisq-network/bisq/pull/1961</a></p>
<h4>Commit Summary</h4>
<ul>
<li>Introduce BisqHelpFormatter</li>
<li>Refactor option parsing configuration</li>
<li>Include executable name and version in help output</li>
</ul>
<h4>File Changes</h4>
<ul>
<li>
<strong>M</strong>
<a href="https://github.com/bisq-network/bisq/pull/1961/files#diff-0">core/src/main/java/bisq/core/app/BisqExecutable.java</a>
(279)
</li>
<li>
<strong>M</strong>
<a href="https://github.com/bisq-network/bisq/pull/1961/files#diff-1">core/src/main/java/bisq/core/app/BisqHeadlessAppMain.java</a>
(5)
</li>
<li>
<strong>A</strong>
<a href="https://github.com/bisq-network/bisq/pull/1961/files#diff-2">core/src/main/java/bisq/core/app/BisqHelpFormatter.java</a>
(131)
</li>
<li>
<strong>M</strong>
<a href="https://github.com/bisq-network/bisq/pull/1961/files#diff-3">core/src/main/java/bisq/core/app/misc/ExecutableForAppWithP2p.java</a>
(4)
</li>
<li>
<strong>A</strong>
<a href="https://github.com/bisq-network/bisq/pull/1961/files#diff-4">core/src/test/java/bisq/core/app/BisqHelpFormatterTest.java</a>
(134)
</li>
<li>
<strong>A</strong>
<a href="https://github.com/bisq-network/bisq/pull/1961/files#diff-5">core/src/test/resources/bisq/core/app/cli-output.txt</a>
(57)
</li>
<li>
<strong>M</strong>
<a href="https://github.com/bisq-network/bisq/pull/1961/files#diff-6">desktop/src/main/java/bisq/desktop/app/BisqAppMain.java</a>
(5)
</li>
<li>
<strong>M</strong>
<a href="https://github.com/bisq-network/bisq/pull/1961/files#diff-7">monitor/src/main/java/bisq/monitor/MonitorMain.java</a>
(18)
</li>
<li>
<strong>M</strong>
<a href="https://github.com/bisq-network/bisq/pull/1961/files#diff-8">seednode/src/main/java/bisq/seednode/SeedNodeMain.java</a>
(4)
</li>
<li>
<strong>M</strong>
<a href="https://github.com/bisq-network/bisq/pull/1961/files#diff-9">statsnode/src/main/java/bisq/statistics/StatisticsMain.java</a>
(4)
</li>
</ul>
<h4>Patch Links:</h4>
<ul>
<li><a href='https://github.com/bisq-network/bisq/pull/1961.patch'>https://github.com/bisq-network/bisq/pull/1961.patch</a></li>
<li><a href='https://github.com/bisq-network/bisq/pull/1961.diff'>https://github.com/bisq-network/bisq/pull/1961.diff</a></li>
</ul>
<p style="font-size:small;-webkit-text-size-adjust:none;color:#666;">—<br />You are receiving this because you are subscribed to this thread.<br />Reply to this email directly, <a href="https://github.com/bisq-network/bisq/pull/1961">view it on GitHub</a>, or <a href="https://github.com/notifications/unsubscribe-auth/AkpZtnaAGSgdZU8AEGBum6WpfF1ElsIaks5uyT4ggaJpZM4YxaLl">mute the thread</a>.<img src="https://github.com/notifications/beacon/AkpZts3BgBYDfBmTx0_CbyzXVuaJZQJfks5uyT4ggaJpZM4YxaLl.gif" height="1" width="1" alt="" /></p>
<script type="application/json" data-scope="inboxmarkup">{"api_version":"1.0","publisher":{"api_key":"05dde50f1d1a384dd78767c55493e4bb","name":"GitHub"},"entity":{"external_key":"github/bisq-network/bisq","title":"bisq-network/bisq","subtitle":"GitHub repository","main_image_url":"https://assets-cdn.github.com/images/email/message_cards/header.png","avatar_image_url":"https://assets-cdn.github.com/images/email/message_cards/avatar.png","action":{"name":"Open in GitHub","url":"https://github.com/bisq-network/bisq"}},"updates":{"snippets":[{"icon":"DESCRIPTION","message":"Redesign CLI help output (#1961)"}],"action":{"name":"View Pull Request","url":"https://github.com/bisq-network/bisq/pull/1961"}}}</script>
<script type="application/ld+json">[
{
"@context": "http://schema.org",
"@type": "EmailMessage",
"potentialAction": {
"@type": "ViewAction",
"target": "https://github.com/bisq-network/bisq/pull/1961",
"url": "https://github.com/bisq-network/bisq/pull/1961",
"name": "View Pull Request"
},
"description": "View this Pull Request on GitHub",
"publisher": {
"@type": "Organization",
"name": "GitHub",
"url": "https://github.com"
}
},
{
"@type": "MessageCard",
"@context": "http://schema.org/extensions",
"hideOriginalBody": "false",
"originator": "AF6C5A86-E920-430C-9C59-A73278B5EFEB",
"title": "Redesign CLI help output (#1961)",
"sections": [
{
"text": "",
"activityTitle": "**Chris Beams**",
"activityImage": "https://assets-cdn.github.com/images/email/message_cards/avatar.png",
"activitySubtitle": "@cbeams",
"facts": [
]
},
{
"title": "Commit Summary",
"facts": [
{
"name": "2a537a6",
"value": "Introduce BisqHelpFormatter"
},
{
"name": "83e1dd3",
"value": "Refactor option parsing configuration"
},
{
"name": "931f369",
"value": "Include executable name and version in help output"
}
]
},
{
"title": "File Changes",
"facts": [
{
"name": "Modified",
"value": "[core/src/main/java/bisq/core/app/BisqExecutable.java](https://github.com/bisq-network/bisq/pull/1961/files#diff-0) (279 changes)"
},
{
"name": "Modified",
"value": "[core/src/main/java/bisq/core/app/BisqHeadlessAppMain.java](https://github.com/bisq-network/bisq/pull/1961/files#diff-1) (5 changes)"
},
{
"name": "Added",
"value": "[core/src/main/java/bisq/core/app/BisqHelpFormatter.java](https://github.com/bisq-network/bisq/pull/1961/files#diff-2) (131 changes)"
},
{
"name": "Modified",
"value": "[core/src/main/java/bisq/core/app/misc/ExecutableForAppWithP2p.java](https://github.com/bisq-network/bisq/pull/1961/files#diff-3) (4 changes)"
},
{
"name": "Added",
"value": "[core/src/test/java/bisq/core/app/BisqHelpFormatterTest.java](https://github.com/bisq-network/bisq/pull/1961/files#diff-4) (134 changes)"
},
{
"name": "Added",
"value": "[core/src/test/resources/bisq/core/app/cli-output.txt](https://github.com/bisq-network/bisq/pull/1961/files#diff-5) (57 changes)"
},
{
"name": "Modified",
"value": "[desktop/src/main/java/bisq/desktop/app/BisqAppMain.java](https://github.com/bisq-network/bisq/pull/1961/files#diff-6) (5 changes)"
},
{
"name": "Modified",
"value": "[monitor/src/main/java/bisq/monitor/MonitorMain.java](https://github.com/bisq-network/bisq/pull/1961/files#diff-7) (18 changes)"
},
{
"name": "Modified",
"value": "[seednode/src/main/java/bisq/seednode/SeedNodeMain.java](https://github.com/bisq-network/bisq/pull/1961/files#diff-8) (4 changes)"
},
{
"name": "Modified",
"value": "[statsnode/src/main/java/bisq/statistics/StatisticsMain.java](https://github.com/bisq-network/bisq/pull/1961/files#diff-9) (4 changes)"
}
]
}
],
"potentialAction": [
{
"name": "Add a comment",
"@type": "ActionCard",
"inputs": [
{
"isMultiLine": true,
"@type": "TextInput",
"id": "IssueComment",
"isRequired": false
}
],
"actions": [
{
"name": "Comment",
"@type": "HttpPOST",
"target": "https://api.github.com",
"body": "{\n\"commandName\": \"IssueComment\",\n\"repositoryFullName\": \"bisq-network/bisq\",\n\"issueId\": 1961,\n\"IssueComment\": \"{{IssueComment.value}}\"\n}"
}
]
},
{
"name": "Close pull request",
"@type": "HttpPOST",
"target": "https://api.github.com",
"body": "{\n\"commandName\": \"PullRequestClose\",\n\"repositoryFullName\": \"bisq-network/bisq\",\n\"pullRequestId\": 1961\n}"
},
{
"targets": [
{
"os": "default",
"uri": "https://github.com/bisq-network/bisq/pull/1961"
}
],
"@type": "OpenUri",
"name": "View on GitHub"
},
{
"targets": [
{
"os": "default",
"uri": "https://github.com/bisq-network/bisq/pull/1961.patch"
}
],
"@type": "OpenUri",
"name": "View patch"
},
{
"targets": [
{
"os": "default",
"uri": "https://github.com/bisq-network/bisq/pull/1961.diff"
}
],
"@type": "OpenUri",
"name": "View diff"
},
{
"name": "Unsubscribe",
"@type": "HttpPOST",
"target": "https://api.github.com",
"body": "{\n\"commandName\": \"MuteNotification\",\n\"threadId\": 415605477\n}"
}
],
"themeColor": "26292E"
}
]</script>