Hacktoberfest 2026：メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Commands doc

オープン
  • 何か問題がありますか？
#3,314 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
3〜5日
初心者へのやさしさ
35/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
停滞
領域
cli, documentation

調査の方向性

まず最新の All GA Features アーカイブをダウンロードして展開し、wlp/bin にある featureUtility、springBootUtility、auditUtility、serverSchemaGen のヘルプ出力を確認します。優先されたコマンドのドキュメントを追加し、ドキュメント化したコマンドラインヘルプが実行時のヘルプと一致するようにします。この issue では、残りのコマンドは対象外としています。

索引モデルが issue の本文から書いたものです。

説明

epic

There are other commands than just the ones we've documented so far. I don't know how urgent it is to document them all (they all have commandline help anyway) but just so you know...

Here's the full list of the commands in OL 20.0.0.12 (the .bat files are for Windows, the ones without suffix are for UNIX/Linux, etc):

laura@Lauras-MacBook-Pro openliberty-200012 % ls wlp/bin 
auditUtility		binaryLog		ddlGen			jaxb			pluginUtility.bat	securityUtility.bat	serverSchemaGen.bat
auditUtility.bat	binaryLog.bat		ddlGen.bat		jaxrs			productInfo		server			springBootUtility
batchManager		client			featureUtility		jaxws			productInfo.bat		server.bat		springBootUtility.bat
batchManager.bat	client.bat		featureUtility.bat	pluginUtility		securityUtility		serverSchemaGen		tools

To find them:

  1. Download the latest "All GA Features" zip from https://www.openliberty.io/downloads/
  2. Extract the zip file into a directory on your laptop (I created a dir called openliberty-200012).
  3. At a command prompt/terminal, move into Liberty's bin directory, eg: cd openliberty-200012/wlp/bin
  4. List the contents of the bin directory: ls
    And there you go.

You can get the help for any of the commands by typing the command's name followed by --help, eg: ./binaryLog --help. You'll see some commands you recognise in there, like server, and securityUtility.

The text in this cmdline help should match the text in the OL docs (if you add the help to the OL docs).

For extra credit (and ease of maintenance), rather than duplicating and keeping in sync, ideally someone would create something to generate the your asciidoc pages from the runtime help files according to some template you define. And then you could raise a PR to fix up the wording in the commandline help in future if you want changes to it for style or whatever.

Update on what I've said above after speaking with Alasdair:

  • the online help for the commands should be good enough that we won't lose anything if not all the commands are documented
  • of the commands in Open Liberty, it would be good to doc the following ones:
    • featureUtility
    • springBootUtility
    • auditUtility
  • I'll add to that the serverSchemaGen command, which he's previously said is useful. Info is currently only in the KC I raised an issue on the runtime to get that fixed.
  • all the other commands are low priority

I think if we consider the scope of this issue's work to just be those three commands, rather than all of them, it's probably ok to manually add them to the docs (rather than trying to get them generated automatically, which would take a fair amount of work, including working out a template of how the info should look etc). Leave the rest of the commands (if there's a need in future, the info is in the online help anyway).

主要言語
言語のデータがありません
スター
14
フォーク
58
平均マージ
1時間 8分
マージ済み PR（30日）
20

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

OpenLiberty/docs のほかの issue

OpenLiberty/docs の issue をすべて見る

似ている issue

CLI の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。