Skip to content

docs: clarify the purpose of --bin #1683

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

Merged
merged 7 commits into from
Nov 11, 2024
Merged

docs: clarify the purpose of --bin #1683

Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
1bf27df
docs: clarify the purpose of --bin
johnnyreilly Nov 9, 2024
13d0b49
chore: prettier
johnnyreilly Nov 9, 2024
84834fe
Update docs/Options.md
johnnyreilly Nov 11, 2024
bc6c71a
docs: bin suggestions
johnnyreilly Nov 11, 2024
8dd2f00
fix: prettier
johnnyreilly Nov 11, 2024
ea66910
fix: prettier
johnnyreilly Nov 11, 2024
3d75098
Update docs/FAQs.md
JoshuaKGoldberg Nov 11, 2024
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
2 changes: 1 addition & 1 deletion docs/Options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ The setup scripts also allow for optional overrides of the following inputs whos

- `--access` _(`"public" | "restricted"`)_: Which [`npm publish --access`](https://docs.npmjs.com/cli/commands/npm-publish#access) to release npm packages with (by default, `"public"`)
- `--author` _(`string`)_: Username on npm to publish packages under (by default, an existing npm author, or the currently logged in npm user, or `owner.toLowerCase()`)
- `--bin` _(`string`)_: `package.json` bin value to include for npx-style running.
- `--bin` _(`string`)_: `package.json` bin value to include for npx-style running. (eg `"./bin/index.js"`) - this does not create any of folders or files; just references to them in the `package.json` bin property
- `--directory` _(`string`)_: Directory to create the repository in (by default, the same name as the repository)
- `--email` _(`string`)_: Email address to be listed as the point of contact in docs and packages (e.g. `[email protected]`)
- Optionally, `--email-github` _(`string`)_ and/or `--email-npm` _(`string`)_ may be provided to use different emails in `.md` files and `package.json`, respectively
Expand Down
Loading