Installation and CLI usage

Ubuntu

Have npm and Node.js installed already? Skip to step 6. If not, read below

1. Update your repo

sudo apt-get update --yes

1. Install npm

sudo apt-get install npm --yes

1. Install Node Version Manager

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.0/install.sh | bash

1. Update the terminal

source ~/.bashrc

1. Install Node.js version 20

nvm install 20

1. Use Node.js version 20

nvm use 20

1. Install the anyone-client

npm install @anyone-protocol/anyone-client

1. If you wish to use it personally, start the anyone-client.

npx anyone-client

Resource: https://www.npmjs.com/package/@anyone-protocol/anyone-client

macOS

Have npm and Node.js installed already? Skip to step 4. If not, read below NPM installation replicates the installation guide here. You can follow this guide on the Terminal app on your Mac.

1. Install nvm by

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.0/install.sh | bash

1. Use nvm to install Node.js 20

nvm install 20

1. Verify that you have installed Node.js and npm by ensuring you get a version code for each of these commands

node -v
npm -v

1. Install the anyone-client

npm install @anyone-protocol/anyone-client

1. If you wish to use it personally, start the anyone-client.

npx anyone-client

Resource: https://www.npmjs.com/package/@anyone-protocol/anyone-client

Windows

Have npm and Node.js installed already? Skip to step 4. If not, read below NPM installation replicates the installation guide here. You can follow this guide on the Command Prompt app on your Desktop.

1. Install fnm (fast node manager) by

winget install Schniz.fnm

1. Use fnm to install Node.js 20

fnm env --use-on-cd | Out-String | Invoke-Expression
fnm use --install-if-missing 20

1. Verify that you have installed Node.js and npm by ensuring you get a version code for each of these commands

node -v
npm -v

1. Install the anyone-client

npm install @anyone-protocol/anyone-client

1. If you wish to use it personally, start the anyone-client.

npx anyone-client

Resource: https://www.npmjs.com/package/@anyone-protocol/anyone-client

Run from CLI

The Anyone Protocol NPM package provides a command-line interface (CLI) that allows you to easily run and configure the Anyone client. This page details how to use the CLI and the available options.

Running the Anyone Client

To run the Anyone client using the CLI, use the following command:

npx anyone-client

This command will start the client with default port settings.

Default Port Settings

When run without any options, the Anyone Client uses the following default ports:

• SocksPort: 9050

• ControlPort: 9051

• OrPort: 9001

CLI Options

You can customize the client's behavior using various command-line options:

Option	Description	Default
-s	Set the SocksPort	9050
-c	Set the ControlPort (use 0 to disable)	9051
-o	Set the OrPort	9001
-v	Enable verbose mode for full client logs	Disabled
-f	Set the path to a custom anonrc config file	None
-b	Set the path to a custom anon binary	None

Example Usage

Here's an example of how to use these options:

npx anyone-client -s 9150 -c 0 -o 9101 -f ./customAnonrc -b /usr/local/bin/anon -v

This command will:

• Set the SocksPort to 9150

• Disable the ControlPort

• Set the OrPort to 9101

• Use a custom anonrc file located at './customAnonrc'

• Use a custom anon binary located at '/usr/local/bin/anon'

• Enable verbose mode

Important Notes

1. When changing ports, ensure they don't conflict with other services on your system.

2. The -b option allows you to use a preinstalled anon binary instead of the one that comes with the package.

Terms and Agreements

To bypass the user agreement automatically, you can create a file named 'terms-agreement' in the working directory. This file should contain the line 'agreed' to be considered valid.