- Node.js (v14 or later)
- npm (v7 or later)
git clone git@github.com:hydra-js/monorepo.git hydra-js-monorepo
cd hydra-js-monorepo/packages/hydra-cli
npm installTo run the CLI tool locally without installing it globally, use:
node index.js init [appName]This section provides instructions on how to use
npm linkfor local development, enabling you to test the CLI tool as if it were installed globally.
To link the CLI tool locally for development and testing, use npm link:
- Run
npm linkin the project directory. This creates a symlink globally:
npm link- Now you can run the
hydracommand from anywhere on your system:
hydra init [appName]This allows you to test changes to the CLI tool without needing to reinstall it each time you make modifications.
To publish the package to npm:
- Ensure you are logged in to npm:
npm login-
Make sure the NPM_TOKEN secret is added to your GitHub repository.
-
Create a new version tag and push it to GitHub:
git tag v1.0.0
git push origin v1.0.0The GitHub Actions workflow will automatically publish the package to npm when a new tag is pushed.
Contributions are welcome! Please submit a pull request or open an issue to discuss your ideas.
This project is licensed under the MIT License.