Skip to content

installation.md

Latest commit

 

History

History
220 lines (143 loc) · 3.98 KB

installation.md

File metadata and controls

220 lines (143 loc) · 3.98 KB
Raw

Installation

This guide explains how to get both required CLIs available locally:

  • nape: the Rust CLI from this repository
  • nape-eval: the evaluator CLI invoked by nape collect report

Official Install Path

The official public install path for the NAPE CLI is the NAPE binary repository.

Download URL shape:

https://repo.napecentral.com/nape-cli/<version>/<operating-system>/<cpu-architecture>/nape

Example for a published macOS Apple Silicon binary:

NAPE_VERSION=1.1.0
curl -L -o nape "https://repo.napecentral.com/nape-cli/${NAPE_VERSION}/macos/aarch64/nape"
chmod +x nape
sudo mv nape /usr/local/bin/nape
nape --version

Use the published version, operating system, and CPU architecture for your environment.

Current operating-system values used by the public docs are:

  • linux-gnu
  • linux-musl
  • macos
  • windows

Current CPU architecture values used by the public docs are:

  • x86_64
  • aarch64

Writerside under ../docs/Writerside is the public documentation source for polished installation flows. This repository keeps current-behavior and developer-local installation documentation.

Integrity note: public binary releases should include checksum, signature, or provenance verification artifacts. Until that release convention is published, follow your organization's software intake controls before installing downloaded binaries onto PATH.

Install NAPE Evaluator

nape collect report shells out to nape-eval.

Install it with:

python3 -m pip install nape

Verify:

nape-eval --check-install

Expected output:

NAPE Evaluator CLI is installed and working.

If your Python environment installs scripts into a user-local bin directory, make sure that directory is on PATH.

Common locations:

$HOME/.local/bin
$HOME/Library/Python/<version>/bin

Developer Fallback: Build NAPE From Source

From the repository root:

cargo build --release -p nape_cli

The binary is written to:

target/release/nape

Verify directly:

./target/release/nape --help

Put NAPE On PATH

For temporary use in the current shell:

export PATH="$PWD/target/release:$PATH"
nape --help

For a local user install, copy the binary into a directory already on your PATH.

Example:

mkdir -p "$HOME/.local/bin"
cp target/release/nape "$HOME/.local/bin/nape"
export PATH="$HOME/.local/bin:$PATH"
nape --help

If you use a shell profile, add the PATH export there.

Verify Both Tools

nape --help
nape collect --help
nape collect start --help
nape-eval --check-install

Build And Test The Repository

Build:

cargo build

Run all tests:

cargo test

Run package-specific tests:

make test-nape-cli
make test-domain

Release Binary Install Target

The Makefile includes:

make build-release
make install

Current behavior:

  • make build-release builds under the sibling ../builds directory.
  • make install copies ../builds/release/nape to /usr/local/bin.

Depending on your machine permissions, copying to /usr/local/bin may require elevated privileges. For development, using target/release or $HOME/.local/bin is usually simpler.

Version Notes

The CLI currently reports version 1.1.0.

Check:

nape --version

Troubleshooting

nape: command not found

The binary is not on PATH. Use:

./target/release/nape --help

or add the binary directory to PATH.

nape-eval: command not found

Install the evaluator:

python3 -m pip install nape

Then confirm the Python scripts directory is on PATH.

nape collect report fails install verification

Run:

nape-eval --check-install

Fix the evaluator install before rerunning nape collect report.

Built binary does not match docs

Confirm which binary is being executed:

which nape
nape --version

If needed, run the built binary directly:

./target/release/nape --help