Skip to content

Latest commit

 

History

History
113 lines (75 loc) · 2.04 KB

README.md

File metadata and controls

113 lines (75 loc) · 2.04 KB
Raw

@hydra-js/cli

npm version

Command-line Toolkit for Hydra.js

Getting started

Usage

Install

npm i -g @hydra-js/cli

Create a new App

Method 1

hydra create [-f|--force] <namespace>

Method 2

npx @hydra-js/cli create [-f|--force] <namespace>

Run

cd <namespace>
hydra serve

Specify npm script to run

hydra serve [-s|--script] dev

Start the server in development mode

hydra serve [-d|--dev]

Development 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 install

Running 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 link for 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:

  1. Run npm link in the project directory. This creates a symlink globally:
npm link
  1. Now you can run the hydra command 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:

  1. Ensure you are logged in to npm:
npm login

  1. Make sure the NPM_TOKEN secret is added to your GitHub repository.

  2. Create a new version tag and push it to GitHub:

git tag v1.0.0
git push origin v1.0.0

The 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.