Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(readme): update CLI commands for katana and torii #391

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+5 −5
Open

docs(readme): update CLI commands for katana and torii #391

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,17 +39,17 @@ npx @dojoengine/create-dojo start -t example-vite-react-sdk

```bash
cd dojo-starter
katana --disable-fee --allowed-origins "*"
katana --dev --dev.no-fee --http.cors_origins "*"
```

2. **Terminal 2: Build and migrate the Dojo starter**

```bash
cd dojo-starter
sozo build && sozo migrate apply
sozo build && sozo migrate

# Start Torii indexer - world address can be found in the print out of migrate
torii --world <WORLD_ADDRESS> --allowed-origins "*"
torii --world <WORLD_ADDRESS> --http.cors_origins "*"
```

3. **Terminal 3: Launch the frontend application**
Expand Down Expand Up @@ -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 "*"
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 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.md

Length 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.

```

**Terminal 2**: Build, migrate, and run Torii
Expand All @@ -230,7 +230,7 @@ To run the examples, you'll need to set up three terminal windows:
3. Run Torii (indexer) with the world address and allowed origins:

```bash
torii --world <WORLD_ADDRESS> --allowed-origins "*"
torii --world <WORLD_ADDRESS> --http.cors_origins '*'
```

Note: The world address may change. Ensure you're using the correct address from your migration output.
Expand Down