docs(readme): update CLI commands for katana and torii #391
Conversation
- Update katana command flags (--dev.no-fee, --http.cors_origins) - Update torii command flags (--world, --http.cors_origins) - Fix sozo migrate command syntax
WalkthroughThis pull request updates command-line instructions in the readme file. The modifications adjust the syntax for starting the Katana node and running the Torii indexer by replacing and adding flags, as well as simplifying the migration command for the Dojo starter. No changes were made to exported entities. Changes
Possibly related PRs
Poem
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
readme.md (1)
233-233: Standardize Quoting Style for Torii Command.
In this section, the Torii command uses single quotes around the asterisk:
torii --world <WORLD_ADDRESS> --http.cors_origins '*'
For consistency with the Quick Start instructions (which use double quotes), it is advisable to standardize the quoting style. Consider updating it to:- torii --world <WORLD_ADDRESS> --http.cors_origins '*' + torii --world <WORLD_ADDRESS> --http.cors_origins "*"This small change will improve the overall clarity.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
readme.md(3 hunks)
🔇 Additional comments (3)
readme.md (3)
42-42: Updated Katana Command in Quick Start Section.
The command now reads:
katana --dev --dev.no-fee --http.cors_origins "*"
This update matches the new CLI flags as described in the PR objectives. Please verify that adding the --dev flag along with --dev.no-fee is the intended change for all usage scenarios.
49-49: Simplification of the Sozo Migrate Command.
The command has been updated to:
sozo build && sozo migrate
This removes the previously used verb ("apply") for migration, simplifying the command to match the updated workflow.
52-52: Updated Torii Command Flags.
The command now uses:
torii --world <WORLD_ADDRESS> --http.cors_origins "*"
This replaces the earlier --allowed-origins flag with --http.cors_origins and ensures the world address is explicitly passed. The update aligns with the new CLI flag requirements.
| @@ -209,7 +209,7 @@ To run the examples, you'll need to set up three terminal windows: | |||
|
|
|||
| 2. Start Katana (local Starknet devnet) with fee disabled and all origins allowed: | |||
| ```bash | |||
| katana --disable-fee --allowed-origins "*" | |||
| katana --dev.no-fee --http.cors_origins "*" | |||
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Consistency Check for Katana Command in Examples Section.
In the “Running The Examples” section, the Katana command is updated to:
katana --dev.no-fee --http.cors_origins "*"
Notice that the --dev flag present in the Quick Start section (line 42) is missing here, which may lead to inconsistencies in user guidance. Consider standardizing the command across the documentation. For example, you could change it to:
- katana --dev.no-fee --http.cors_origins "*"
+ katana --dev --dev.no-fee --http.cors_origins "*"Please verify if the --dev flag is mandatory in both contexts.
I'm going to gather more context from the repository to see how the Katana command appears in the documentation. In particular, I'll search for all occurrences of the command (including the flags) in readme.md to verify if the --dev flag is used consistently across sections.
🏁 Script executed:
#!/bin/bash
# Show all occurrences of the 'katana' command within readme.md with line numbers
rg --line-number 'katana' readme.mdLength of output: 144
Inconsistency found in Katana command usage.
- Line 42 uses:
katana --dev --dev.no-fee --http.cors_origins "*" - Line 212 uses:
katana --dev.no-fee --http.cors_origins "*"
Based on the Quick Start section, the --dev flag appears necessary. I recommend standardizing the command in the “Running The Examples” section by adding the missing --dev flag.
Summary by CodeRabbit