@hydra-js/cli
v1.0.0-alpha.4
Published
Hydra-JS Command-line Toolkit
Readme
@hydra-js/cli
Command-line Toolkit for Hydra.js
Getting started
Usage
Install
npm i -g @hydra-js/cliCreate a new App
Method 1
hydra create [-f|--force] <namespace>Method 2
npx @hydra-js/cli create [-f|--force] <namespace>Run
cd <namespace>
hydra serveSpecify npm script to run
hydra serve --script dev // hydra serve -s devDevelopment Setup
Prerequisites
- Node.js (v14 or later)
- npm (v7 or later)
Setting up locally
git clone [email protected]:hydra-js/cli.git hydra-cli
cd hydra-cli
npm installRunning locally
To run the CLI tool locally without installing it, use:
node index.js create [-f|--force] <namespace>Running locally with npm link
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 create [-f|--force] <namespace>This allows you to test changes to the CLI tool without needing to reinstall it each time you make modifications.
Publishing
To publish the package to npm:
- Ensure you are logged in to npm:
npm loginMake 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.
Contributing
Contributions are welcome! Please submit a pull request or open an issue to discuss your ideas.
License
This project is licensed under the MIT License.
