@pleaseai/code-style
v0.0.1
Published
CLI to set up PleaseAI code style (eslint, prettier, editorconfig, AGENTS.md) in any project
Downloads
73
Maintainers
Readme
@pleaseai/code-style
CLI that wires PleaseAI's shared code style into any project — installs the
eslint/prettier/editorconfig packages and manages the AGENTS.md rules block
so AI coding assistants know how to write code that passes lint on the first
try.
Inspired by ultracite and
NaverPay's @naverpay/code-style-cli.
Usage
From the root of any project that has a package.json:
bunx @pleaseai/code-style # same as `init`
bunx @pleaseai/code-style init # interactive setup
bunx @pleaseai/code-style update # re-apply the AGENTS.md rules block only
bunx @pleaseai/code-style doctor # check current project statusAlso works with npx, pnpm dlx, and yarn dlx.
What it does
The init command:
- Detects your package manager (bun → pnpm → yarn → npm, based on lockfile).
- Shows a checkbox UI listing PleaseAI code-style tools; already-installed
ones are labelled
(installed)/(설치됨). - Installs the packages you selected as dev dependencies.
- Writes / updates the corresponding config files.
Supported tools
| Tool | npm package(s) | Config file |
| --- | --- | --- |
| eslint-config | @pleaseai/eslint-config, eslint | eslint.config.mjs |
| prettier-config | @pleaseai/prettier-config, prettier | package.json#prettier |
| editorconfig | @pleaseai/editorconfig | .editorconfig (copied from node_modules) |
| agents-md | — | AGENTS.md (marker-managed block) |
AGENTS.md block
The CLI owns only the content between these markers — everything else in
AGENTS.md is your content and is preserved verbatim:
<!-- pleaseai-code-style:start -->
...managed content...
<!-- pleaseai-code-style:end -->Re-run pleaseai-code-style update any time you upgrade @pleaseai/code-style
to refresh just this block. The full rules list is shipped as
node_modules/@pleaseai/code-style/rules.md for reference.
Options
| Flag | Description |
| --- | --- |
| --yes, -y | Accept defaults, overwrite existing files without prompting |
| --lang <ko\|en> | Force the CLI locale (defaults to $LANG) |
| --help, -h | Print help |
| --version, -v | Print version |
Localisation
The CLI auto-detects your locale from LC_ALL / LANG / LC_MESSAGES and
currently ships Korean and English messages. Override with --lang ko or
--lang en.
License
MIT
