tv-recommender-cli
v0.0.1-53861d291843
Published
CLI tool for TV recommendations using TVDB API
Readme
tv-recommender
Welcome and thank you for using tv-recommender.
Installation
Install the CLI tool globally via npm:
npm install -g tv-recommender-cli@latestSetup
- Install dependencies:
npm install- Create a
.envfile in the project root with yourSERVER_API_KEY:
SERVER_API_KEY=your-api-key-hereGet the SERVER_API_KEY from one of the admins.
Running the Server
To start the development server, use the provided shell script:
./run-server.shThis script will:
- Check for the
.envfile - Load the
SERVER_API_KEYfrom.env - Start the server in development mode (with hot-reload)
The server will run on http://localhost:3000 by default.
Running the CLI
Before running the CLI, you need to build it:
npm run buildThen run the CLI using the provided shell script:
./run-cli.shThis script will:
- Check that the CLI is built
- Check for the
.envfile - Load the
SERVER_API_KEYfrom.env - Start the CLI in interactive mode
The CLI will make POST requests to the server endpoint. Press Ctrl+C to exit.
Optional: Server URL
You can optionally set SERVER_URL in your .env file if the server is running on a different URL:
SERVER_API_KEY=your-api-key-here
SERVER_URL=http://localhost:3000If not set, the CLI defaults to http://localhost:3000.
