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.

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

fix: Eli2 134/make npm create eliza and npx elizaos create functionally identical #4185

Conversation

yungalgo
Copy link

@yungalgo yungalgo commented Apr 4, 2025

Enhanced Command-Line Handling for create-eliza

This PR improves the user experience of the create-eliza CLI tool with comprehensive flag handling and path detection:

1. Robust Flag and Argument Processing

  • Properly handles all supported flags: -d/--dir, -t/--type, and -y/--yes
  • Ensures flags are correctly passed to the underlying CLI regardless of position
  • Preserves flag functionality when using both npm and npx command forms

2. Intelligent Directory Path Detection

  • Added smart path detection to recognize various directory path formats
  • Now correctly handles directory names with or without path separators
  • Supports multiple command syntax patterns:
  • Standard flag usage: npm create eliza -d ./my-dir
  • Auto-detected paths: npm create eliza ./my-dir or npm create eliza my-project-dir
  • Combined with type: npm create eliza plugin ./plugins-dir/my-plugin

3. Consistent Help Command Experience

  • Added a dedicated help command that works with npm: npm create eliza help
  • Help output matches exactly what users see with npx elizaos create --help
  • Welcome message only appears when creating projects, not when viewing help

These changes standardize the CLI experience across npm and npx command forms, making it more intuitive and aligned with user expectations. Any command that works with npx elizaos create now works consistently with npm create eliza, providing a seamless developer experience.

@yungalgo yungalgo added the V2 Eliza 1.x label Apr 4, 2025
Copy link
Contributor

coderabbitai bot commented Apr 4, 2025

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

@wtfsayo wtfsayo changed the title Eli2 134/make npm create eliza and npx elizaos create functionally identical chore: Eli2 134/make npm create eliza and npx elizaos create functionally identical Apr 8, 2025
@wtfsayo wtfsayo changed the title chore: Eli2 134/make npm create eliza and npx elizaos create functionally identical fix: Eli2 134/make npm create eliza and npx elizaos create functionally identical Apr 8, 2025
@wtfsayo wtfsayo merged commit d1f4fa7 into v2-develop Apr 8, 2025
1 of 2 checks passed
@wtfsayo wtfsayo deleted the ELI2-134/make-npm-create-eliza-and-npx-elizaos-create-functionally-identical branch April 8, 2025 09:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
V2 Eliza 1.x
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants