@reframejs/cli 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Reframe
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,56 @@
+# Reframe CLI
+
+Install published Framer components into a React project as local JSX or TSX
+source with the Reframe CLI.
+
+## Requirements
+
+- Node.js 22 or newer
+- An existing React project with a `package.json`
+- A Reframe component export ID from the Reframe Framer plugin
+
+## Commands
+
+Run commands from the directory containing your project’s `package.json`:
+
+```sh
+pnpx @reframejs/cli login
+pnpx @reframejs/cli init
+pnpx @reframejs/cli add <component-id>
+```
+
+The CLI stores your local credential in the operating system’s Reframe config
+directory. `status` checks the current account and `logout` removes the local
+credential:
+
+```sh
+pnpx @reframejs/cli status
+pnpx @reframejs/cli logout
+```
+
+`init` detects the project structure and lets you choose where the managed
+`framer/` directory belongs. `add` downloads the selected component, its
+assets, and its component stylesheet. JavaScript projects receive JSX output;
+TypeScript projects receive a typed TSX facade alongside the generated runtime.
+
+Use `--yes` to accept an update without a prompt:
+
+```sh
+pnpx @reframejs/cli add <component-id> --yes
+```
+
+Create a small Vite preview app for an exported component with:
+
+```sh
+pnpx @reframejs/cli create --component <component-id>
+```
+
+Pass `--out <directory>` to choose the preview directory or `--no-install` to
+skip installing its generated dependencies.
+
+Generated files include inline comments that point to the Reframe
+documentation. The documentation URL is configured by the CLI release, so
+users do not need to edit generated source or project configuration when the
+documentation domain changes.
+
+Run `pnpx @reframejs/cli --help` for the complete command list.