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

--mode flag is no longer mentionned in npm init adonisjs@latest -- -K="user/repo" --mode=git command #173

Open
MGouillardon opened this issue Dec 4, 2024 · 0 comments

Comments

@MGouillardon
Copy link

Documentation Inconsistency: Starter Kit Git Mode Flag

Current Documentation

The documentation at URL states that private repositories can be downloaded using:

npm init adonisjs@latest -- -K="user/repo" --mode=git

Actual Behavior

The --mode=git flag is not recognized by the CLI, resulting in:

image

Expected Behavior

According to the CLI help (npm init adonisjs@latest -- --help), the correct way to handle private repositories is to use the -t, --token flag
image

npm init adonisjs@latest -- -K="organization/repo" -t="github_token"

Proposed Documentation Update

The documentation should be updated to:

  1. Remove the --mode=git reference
  2. Add information about using the -t, --token flag for private repositories
  3. Include examples for both personal and organization repositories

Additional Context

This issue affects users trying to set up new AdonisJS projects from private repositories, especially those hosted in organizations.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant