Anyone Protocol NPM Package

The official NPM package for the Anyone Protocol. It is a client that can be used to interact with the Anyone Protocol and the ecosystem. Circuits are created through the network that are used to tunnel application or personal traffic to an end destination anonymously.

Install

npm install @anyone-protocol/anyone-client

Run Anon Client

npx anyone-client

Build

npm run build

CLI Options

Running npx anyone-client, will start the client with the following default ports:

• SocksPort: 9050
• ControlPort: 9051
• OrPort: 9001

You can customize the port settings using command-line options:

• -s: Set the SocksPort (default: 9050)
• -c: Set the ControlPort (default: 9051, use 0 to disable)
• -o: Set the OrPort (default: 9001)
• -v: Enable verbose mode for full client logs
• -f: Set the path to custom anonrc config file
• -b: Set the path to custom anon binary (To use preinstalled one)

Example:

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

This command will run the client with the SocksPort set to 9150, ControlPort disabled, OrPort set to 9101, a anonrc file set to './customAnonrc', a binary path set to '/usr/local/bin/anon' and verbose mode enabled.

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

Terms and agreements

In order to bypass user agreement automatically file with name 'terms-agreement' should be placed in the working directory. File should contain 'agreed' line to be valid.

Docs

To generate API docs:

npm run typedoc

Docs will be generated to docs/ directory, open index.html to view it

Additional Information

For more comprehensive information about the Anyone Protocol SDK, please visit our official documentation at:

https://docs.anyone.io/sdk

This resource provides in-depth guides, tutorials, and reference materials to help you make the most of the Anyone Protocol in your projects.