proximamp command reference

Every proximamp command, its options and the exit codes. In the terminal, proximamp help <command> shows the same help.

Help of proximamp 1.0.1.

proximamp <command> [arguments] [options]

Command	What it does
help	Show help for proximamp, for a command, or for the exit codes
version	Show the version of proximamp
login	Sign in on this computer: with a password, through VK ID or Yandex ID in the browser, with a device key, or with a code approved on your phone
signup	Make a ProximaMP account: login, email and password, or through VK ID or Yandex ID
verify	Confirm a new account's email with the code from the email, or ask for a new code
password	The account's password: reset a forgotten one, set a first one, or change it
email	The account's email: show it, add one and confirm it with the code from the email
logout	Sign out on this computer
whoami	Show which account this computer is signed in to
keys	Device keys a server, a service or a container signs in with: make one, list them, revoke one
devices	Where the account is signed in: list the devices, rename one, sign one out
account	Show the account's tariff, its paid term and what of it is used
plans	Show the tariffs on offer (works without signing in)
payments	Show the account's payments
buy	Buy a tariff: prints the payment page's link and a QR code for a phone
up	Open every tunnel a proximamp.yml declares and keep them open until Ctrl+C
service	Keep the config's tunnels as a service that starts with the computer
update	Update proximamp to the newest release
tcp	Open a TCP port of this computer to the internet and keep it open until Ctrl+C
udp	Open a UDP port of this computer to the internet and keep it open until Ctrl+C
http	Give a web site on this computer an https link and keep it until Ctrl+C
https	Give a web site on this computer that itself works over https an https link and keep it until Ctrl+C
ls	Show the account's open tunnels
close	Close a tunnel of this computer by its id or address
addresses	Show the addresses the account holds for its closed tunnels, or let one go
inspect	Show the requests to a link of this computer in the browser (the inspector), or here as lines with --text, until Ctrl+C
access	Choose who may reach an address: allow and deny lists, limits per visitor, a login or a key on a link

proximamp help

Show help for proximamp, for a command, or for the exit codes

proximamp help [<command> | exit-codes]

proximamp version

Show the version of proximamp

proximamp version

proximamp login

Sign in on this computer: with a password, through VK ID or Yandex ID in the browser, with a device key, or with a code approved on your phone

proximamp login [<login>] [--password-stdin]
proximamp login --vk | --yandex
proximamp login --key | --key-stdin
proximamp login --remote [<login>]

Option	Description
--password-stdin	Read the password from standard input, one line (a current and a new password: one line each)
--vk	Sign in through VK ID in the browser
--yandex	Sign in through Yandex ID in the browser
--no-browser	Do not open the browser, only print the link
--accept-terms	Accept the terms of use (https://proximamp.com/en/terms) without being asked
--new-account	When an account already has the email VK ID or Yandex ID gives, make a separate new one
--key	Sign in with a device key, typed unseen
--key-stdin	Sign in with a device key read from standard input, one line
--remote	Sign in with a code you approve on your phone or another computer, for a machine without a browser; a login after it keeps the sign-in only for that account, and is needed without a terminal

proximamp signup

Make a ProximaMP account: login, email and password, or through VK ID or Yandex ID

proximamp signup [--login <login>] [--email <email>] [--password-stdin] [--accept-terms]
proximamp signup --vk | --yandex

Option	Description
--login login	The new account's login
--email email	The new account's email
--password-stdin	Read the password from standard input, one line (a current and a new password: one line each)
--accept-terms	Accept the terms of use (https://proximamp.com/en/terms) without being asked
--vk	Sign in through VK ID in the browser
--yandex	Sign in through Yandex ID in the browser
--no-browser	Do not open the browser, only print the link
--new-account	When an account already has the email VK ID or Yandex ID gives, make a separate new one

proximamp verify

Confirm a new account's email with the code from the email, or ask for a new code

proximamp verify <login> [<code>]
proximamp verify <login> --resend

Option	Description
--resend	Send a new code to the account's email

proximamp password

The account's password: reset a forgotten one, set a first one, or change it

proximamp password reset [<email>] [--code-stdin] [--password-stdin]
proximamp password set [--password-stdin]
proximamp password change [--password-stdin]

Option	Description
--code-stdin	Read the code from the email from standard input, the first line (the new password, with --password-stdin, the next)
--password-stdin	Read the password from standard input, one line (a current and a new password: one line each)
--vk	Sign in through VK ID in the browser
--yandex	Sign in through Yandex ID in the browser
--no-browser	Do not open the browser, only print the link

proximamp email

The account's email: show it, add one and confirm it with the code from the email

proximamp email
proximamp email add [<email>] [--password-stdin | --vk | --yandex] [--no-browser]
proximamp email confirm [<code>]

Option	Description
--password-stdin	Read the password from standard input, one line (a current and a new password: one line each)
--vk	Sign in through VK ID in the browser
--yandex	Sign in through Yandex ID in the browser
--no-browser	Do not open the browser, only print the link

proximamp logout

Sign out on this computer

proximamp logout

proximamp whoami

Show which account this computer is signed in to

proximamp whoami

proximamp keys

Device keys a server, a service or a container signs in with: make one, list them, revoke one

proximamp keys [ls]
proximamp keys create --name <name> [--protection] [--usage] [--expires 30|90] [--password-stdin | --vk | --yandex]
proximamp keys revoke <id> [--yes]

Option	Description
--name name	The key's name, 1 to 48 characters
--protection	The key may also protect addresses: allow and deny lists, logins and keys on links
--usage	The key may also see the tariff and the usage
--expires days	The key expires after 30 or 90 days; without this it does not expire
--password-stdin	Read the password from standard input, one line (a current and a new password: one line each)
--vk	Sign in through VK ID in the browser
--yandex	Sign in through Yandex ID in the browser
--no-browser	Do not open the browser, only print the link
--yes	Do it without asking

proximamp devices

Where the account is signed in: list the devices, rename one, sign one out

proximamp devices
proximamp devices rename <id> <name>
proximamp devices sign-out <id> [--yes]

Option	Description
--yes	Do it without asking

proximamp account

Show the account's tariff, its paid term and what of it is used

proximamp account

proximamp plans

Show the tariffs on offer (works without signing in)

proximamp plans

proximamp payments

Show the account's payments

proximamp payments

proximamp buy

Buy a tariff: prints the payment page's link and a QR code for a phone

proximamp buy <tariff>

proximamp up

Open every tunnel a proximamp.yml declares and keep them open until Ctrl+C

proximamp up [--config <file> | -c <file>]

Option	Description
--config file	The config to read (proximamp.yml in this folder when not given)
-c file	The config to read (proximamp.yml in this folder when not given)
--wait-sign-in	Without a sign-in, wait for one instead of ending, and retry a refused tunnel (as the service does)

proximamp service

Keep the config's tunnels as a service that starts with the computer

proximamp service install [<login>] [-c <file>] [--password-stdin | --key-stdin]
proximamp service login [<login>] [--password-stdin | --key-stdin]
proximamp service status
proximamp service inspect [<link | id>] [--port <port> | --text]
proximamp service access <address> [<words and options of proximamp access>]
proximamp service uninstall [--yes]

Option	Description
--config file	The config to read (proximamp.yml in this folder when not given)
-c file	The config to read (proximamp.yml in this folder when not given)
--password-stdin	Read the password from standard input, one line (a current and a new password: one line each)
--key-stdin	Sign in with a device key read from standard input, one line
--yes	Do it without asking
--text	The requests as lines in this terminal instead of the browser: a server whose browser cannot reach the page
--port port	The port of 127.0.0.1 the inspector page is served on; a free one when not given
--deny	use: use the list as a deny list
--ban-per-minute n	limit: ban a visitor address after more new connections a minute than this (5 to 1000, off, default)
--ban-minutes n	limit: how long a ban lasts, 1 to 1440 minutes, or default
--tcp-share n	limit: TCP connections one visitor address may hold, 1 to 128, or default
--udp-share n	limit: UDP flows one visitor address may hold, 1 to 256, or default
--overlap minutes	key rotate: minutes the old key keeps working: 0, 60 (when not given), 1440 or 10080
--burst n	requests, key limit: requests let through at once above the rate
--methods list	rule add: only these methods, comma separated (GET, HEAD, POST, PUT, PATCH, DELETE, OPTIONS)
--at n	rule add: the rule's place, 1 first (last when not given)
--minutes n	failures: the minutes the failures are counted in
--pause minutes	failures: how many minutes a visitor address is paused

proximamp update

Update proximamp to the newest release

proximamp update

proximamp tcp

Open a TCP port of this computer to the internet and keep it open until Ctrl+C

proximamp tcp <port> [--udp] [--host <host>] [--address <address> | --new]

Option	Description
--udp	The same port answers UDP as well (a game server that needs both)
--host host	Send visitors to this host instead of this computer (another computer of your network)
--address address	Open on this held address (see proximamp addresses)
--new	Take a new address, not the one this tunnel had last

proximamp udp

Open a UDP port of this computer to the internet and keep it open until Ctrl+C

proximamp udp <port> [--host <host>] [--address <address> | --new]

Option	Description
--host host	Send visitors to this host instead of this computer (another computer of your network)
--address address	Open on this held address (see proximamp addresses)
--new	Take a new address, not the one this tunnel had last

proximamp http

Give a web site on this computer an https link and keep it until Ctrl+C

proximamp http <port> [--host <host>] [--address <link> | --new] [--inspect]

Option	Description
--host host	Send visitors to this host instead of this computer (another computer of your network)
--address address	Open on this held address (see proximamp addresses)
--new	Take a new address, not the one this tunnel had last
--inspect	Show the requests to the link in the browser, as proximamp inspect does

proximamp https

Give a web site on this computer that itself works over https an https link and keep it until Ctrl+C

proximamp https <port> [--host <host>] [--address <link> | --new] [--inspect]

Option	Description
--host host	Send visitors to this host instead of this computer (another computer of your network)
--address address	Open on this held address (see proximamp addresses)
--new	Take a new address, not the one this tunnel had last
--inspect	Show the requests to the link in the browser, as proximamp inspect does

proximamp ls

Show the account's open tunnels

proximamp ls

proximamp close

Close a tunnel of this computer by its id or address

proximamp close <id | address>

proximamp addresses

Show the addresses the account holds for its closed tunnels, or let one go

proximamp addresses [release <address>] [--yes]

Option	Description
--yes	Do it without asking

proximamp inspect

Show the requests to a link of this computer in the browser (the inspector), or here as lines with --text, until Ctrl+C

proximamp inspect [<link | id>] [--no-browser] [--port <port>]
proximamp inspect --text [<link | id>]

Option	Description
--no-browser	Do not open the browser, only print the link
--port port	The port of 127.0.0.1 the inspector page is served on; a free one when not given
--text	The requests as lines in this terminal instead of the browser: a server whose browser cannot reach the page

proximamp access

Choose who may reach an address: allow and deny lists, limits per visitor, a login or a key on a link

proximamp access <address> [allow|deny|remove <ip or range>... | clear]
proximamp access <address> limit [--ban-per-minute <n>|off] [--ban-minutes <n>] [--tcp-share <n>] [--udp-share <n>]
proximamp access <address> limit default
proximamp access <address> use <list> [--deny]
proximamp access <address> drop <list>
proximamp access lists
proximamp access lists create <name> [<ip or range>...]
proximamp access lists set|add|remove <list> <ip or range>...
proximamp access lists rename <list> <name>
proximamp access lists delete <list>
proximamp access <link> login add|password|on|off|remove <login> [--password-stdin]
proximamp access <link> key add|rotate|show|remove <name> [--overlap <minutes>]
proximamp access <link> key limit <name> <per-minute>|off [--burst <n>]
proximamp access <link> rule add <path> open|login|addresses [<ip or range>...] [--methods GET,POST] [--at <n>]
proximamp access <link> rule remove <n>
proximamp access <link> rule clear
proximamp access <link> requests anonymous|signed-in|keys <per-minute>|off [--burst <n>]
proximamp access <link> failures password|key <max>|off|default [--minutes <n>] [--pause <minutes>]
proximamp access <link> sign-out-everyone
proximamp access <link> unpause <visitor address>

Option	Description
--yes	Agree in advance: delete a shared list, or leave an address open to everyone
--deny	use: use the list as a deny list
--ban-per-minute n	limit: ban a visitor address after more new connections a minute than this (5 to 1000, off, default)
--ban-minutes n	limit: how long a ban lasts, 1 to 1440 minutes, or default
--tcp-share n	limit: TCP connections one visitor address may hold, 1 to 128, or default
--udp-share n	limit: UDP flows one visitor address may hold, 1 to 256, or default
--password-stdin	Read the password from standard input, one line (a current and a new password: one line each)
--overlap minutes	key rotate: minutes the old key keeps working: 0, 60 (when not given), 1440 or 10080
--burst n	requests, key limit: requests let through at once above the rate
--methods list	rule add: only these methods, comma separated (GET, HEAD, POST, PUT, PATCH, DELETE, OPTIONS)
--at n	rule add: the rule's place, 1 first (last when not given)
--minutes n	failures: the minutes the failures are counted in
--pause minutes	failures: how many minutes a visitor address is paused

Options for every command

Option	Description
--json	Print the result as JSON, for scripts
-h, --help	Show help for the command
--version	Show the version of proximamp

Exit codes

Code	Meaning
0	done
1	failed for a reason not listed below
2	the command line is wrong: an unknown command or option, a missing or extra argument
3	not signed in, or the sign-in has ended: run proximamp login
4	no connection to ProximaMP: check the internet and try again
5	ProximaMP said no: a limit or the tariff, a wrong password, or what was asked for does not exist
6	the proximamp agent on this computer could not be started or reached
7	this proximamp is too old for ProximaMP: update it
130	stopped with Ctrl+C