fix op-deployer commands

[zhiqiangxu]

This PR fixes the wrong command line for op-deployer:

# ./bin/op-deployer  --workdir .deployer inspect genesis $L2_CHAIN_ID
Incorrect Usage: flag provided but not defined: -workdir

NAME:
   op-deployer - Tool to configure and deploy OP Chains.

USAGE:
   op-deployer [global options] command [command options]

[netlify]

✅ Deploy Preview for docs-optimism ready!

Name	Link
🔨 Latest commit	153b1b0
🔍 Latest deploy log	https://app.netlify.com/sites/docs-optimism/deploys/673821b09f6c38000806aed9
😎 Deploy Preview	https://deploy-preview-1121--docs-optimism.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request introduces several modifications to the documentation for the op-deployer tool, aimed at enhancing clarity and usability in the deployment process of the OP Stack. Key changes include an update to the command syntax for inspecting chain information, where the --workdir flag's position has been shifted from before to after the inspect command. This adjustment applies to commands for generating genesis files and rollup configurations. Additionally, the documentation now includes a caution regarding the use of default addresses in the intent file, highlighting that these addresses originate from a test mnemonic and should not be employed in production settings. The section detailing deployment usage has been refined to provide clearer instructions on configuring and applying the intent file, along with the necessary command-line arguments. Furthermore, a new section on bootstrap usage has been added, offering guidance on deploying OPCM to new chains. Overall, these changes aim to improve the instructional quality of the documentation for users of the op-deployer tool.

Possibly related issues

• [2024 Q4 Audit] builders/chain-operators/deploy/overview.md #991: This issue involves updating documentation related to deploying standard OP Stack chains, which may align with the improvements made to the op-deployer documentation.

Possibly related PRs

• Update create-l2-rollup.mdx #824: Updates command-line options and documentation related to batchers and proposers, intersecting with command syntax changes in the op-deployer PR.
• op-deployer + opcm documentation #934: Introduces documentation for op-deployer, directly related to the changes made in the main PR.
• Op deployer updates #1020: Includes updates to the op-deployer documentation, enhancing clarity and detail, closely aligning with the main PR's changes.
• adding op-deployer callouts #1016: Adds callouts in documentation directing users to the op-deployer tool, relevant to the focus of the main PR.
• Deploy the L1 contract command path updated #1092: Updates the command path for deploying L1 contracts, relevant to the command syntax changes in the op-deployer PR.

Suggested reviewers

• sbvegan: Suggested reviewer based on involvement with related documentation and updates.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 1a27d54 and 153b1b0.

📒 Files selected for processing (1)

• pages/builders/chain-operators/tools/op-deployer.mdx (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

pages/builders/chain-operators/tools/op-deployer.mdx (1)

Pattern **/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:

• Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
• Avoid gender-specific language and use the imperative form.
• Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
• Ensure proper nouns are capitalized in sentences.
• Apply the Oxford comma.
• Use proper title case for buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
• Use correct spelling and grammar at all times (IMPORTANT).
• For H1, H2, and H3 headers:
  1. Use sentence case, capitalizing only the first word.
  2. Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
  3. Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
• Flag any headers that seem to inconsistently apply these rules for manual review.
• When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
  "

🔇 Additional comments (2)

pages/builders/chain-operators/tools/op-deployer.mdx (2)

141-142: Command syntax improvements look good!

The updated command syntax follows the standard CLI pattern where command-specific options follow the command. This matches the tool's usage format: op-deployer [global options] command [command options].

---

148-150: Additional inspect commands are well documented!

The commands are consistently formatted and each includes a clear description of its purpose.