Sign inSign up

darthjee/navi-hey-client

By darthjee

Updated 12 days ago

Image
0

154

darthjee/navi-hey-client repository overview

navi-hey-client

Codacy Badge Codacy Badge Build Status


Overview

navi-hey-client is a thin Node.js client (library + CLI) for Navi's token-secured /api/* HTTP namespace (POST /api/config, POST /api/engine/start, POST /api/engine/stop), wrapped in a ready-to-run Docker image. It allows external, programmatic control of a running Navi instance without hand-rolling requests and bearer-token handling yourself.


Quick Start

The image's default command is navi-client itself (CMD navi-client, no ENTRYPOINT), so it must be named explicitly in every invocation:

docker run --rm darthjee/navi-hey-client:latest \
  navi-client --base-url http://localhost:3000 --token $NAVI_API_TOKEN --action engine-stop
CircleCI

Declare darthjee/navi-hey-client:latest directly as the job's executor image to get direct filesystem access to checked-out files with no Docker-in-Docker:

jobs:
  warm-cache:
    docker:
      - image: darthjee/navi-hey-client:latest
    steps:
      - checkout
      - run:
          name: Warm cache with Navi client
          command: navi-client --base-url https://your-app.example.com --token $NAVI_API_TOKEN --action engine-start

CLI options

OptionShortDescription
--base-url-bBase URL of the running Navi instance. Required.
--token-tBearer token. Required.
--action-aOne of config, engine-start, engine-stop. Required.
--payload-pOptional JSON request body (used by config/engine-start).

Source & Documentation

GitHub repository: darthjee/navi

Integration guide for developers and AI agents: How to Use navi-hey-client

Tag summary

Content type

Image

Digest

sha256:109af802c

Size

428.9 MB

Last updated

12 days ago

docker pull darthjee/navi-hey-client