@pipelink/cli
v0.0.1
Published
PipeLink local CLI agent for creating developer tunnels.
Readme
PipeLink CLI
PipeLink CLI creates developer tunnels from a local app to a PipeLink relay. It connects to the relay over WebSocket, registers a tunnel, and forwards public HTTP/WebSocket traffic to a local target such as http://127.0.0.1:3000.
This package is the installable PipeLink CLI package. Do not commit npm tokens, relay auth tokens, or release credentials.
Install
npm install -g @pipelink/cli
pipelink --help
pipelink --versionBuild
From the repository root:
pnpm --filter @pipelink/cli buildLocal Tarball Install
Build and pack the CLI package:
pnpm --filter @pipelink/cli build
pnpm --filter @pipelink/cli pack --pack-destination /tmp/pipelink-cli-packInstall the generated tarball locally:
npm install -g /tmp/pipelink-cli-pack/pipelink-cli-*.tgz
pipelink --help
pipelink --versionUninstall it when finished:
npm uninstall -g @pipelink/cliLocal Link Install
For repository development, a pnpm global link is still useful:
cd packages/cli
pnpm link --global
pipelink --helpConfigure
Create an agent token in the PipeLink dashboard, then save the relay URL and token once.
Token path:
- Open
https://app.pipelink.store. - Sign in with the temporary admin API token.
- Open
Agent Tokens. - Create a token for your project.
- Copy the raw token immediately. It is only shown once.
pipelink config set relay-url wss://relay.pipelink.store/agent/connect
pipelink config set auth-token <paste-agent-token-here>
pipelink config showThe token is masked in CLI output after it is saved.
Run
Start a tunnel to a local app:
pipelink http 3000Run diagnostics without creating a tunnel:
pipelink doctor
pipelink doctor --port 3000Security
- Do not commit auth tokens or generated config files.
- Saved config is stored locally at
~/.pipelink/config.json. - Use environment variables or
--auth-tokenon shared machines instead of saving a token. - The CLI never prints the full auth token in normal output.
