docs: AIエージェント向けにREADMEを全面改訂#7
Conversation
- AIエージェント向けクイックリファレンスを冒頭に配置(出力規約・終了コード・ワークフロー例) - 新コマンドを追加: doc financial, company financials, schema financial-elements, schema derived-metrics - 新フラグを追加: doc list --doc-description - 派生財務指標(ROE, ROA, FCF等9指標)の計算式セクションを追加 - 主要書類種別コードの早見表を追加 - doc dataを非推奨としdoc financialへ誘導 - アーキテクチャにinternal/financial/パッケージを追加 - コマンド名をedinet-cliからedinetに統一
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 5940ca8c70
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
|
||
| # 今日の開示書類を一覧表示 | ||
| edinet-cli doc list --date 2026-03-31 | ||
| edinet doc list --date 2026-03-31 |
There was a problem hiding this comment.
Use actual installed binary name in README examples
The new examples invoke edinet, but the documented install/build paths produce an edinet-cli executable (go install github.com/beatinaniwa/edinet-cli@latest and make build both yield that name). As written, users following the README will hit command not found unless they manually rename or symlink the binary, so the quickstart and command reference are not directly runnable.
Useful? React with 👍 / 👎.
| edinet-cli company search E00010 --industry 自動車 | ||
| edinet company search トヨタ | ||
| edinet company search 7203 | ||
| edinet company search --industry 自動車 |
There was a problem hiding this comment.
Keep required
<query> argument in company search example
This example omits the required positional query argument for company search, so it will fail argument validation immediately. The command is defined as search <query> with cobra.ExactArgs(1), so users need something like edinet-cli company search トヨタ --industry 自動車 rather than an industry-only invocation.
Useful? React with 👍 / 👎.
Codexレビュー指摘対応: - コマンド例をedinet → edinet-cli に修正(実際のバイナリ名に合わせる) - company search --industry の例に必須のquery引数を追加
|
@codex review |
|
Codex Review: Didn't find any major issues. 👍 ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
Summary
doc financial,company financials,schema financial-elements,schema derived-metrics)と新フラグ(--doc-description)を追加doc dataを非推奨としdoc financialへ誘導、コマンド名をedinet-cli→edinetに統一Test plan
🤖 Generated with Claude Code