{"id":930,"date":"2025-09-29T21:05:06","date_gmt":"2025-09-29T21:05:06","guid":{"rendered":"https:\/\/protolinker.com\/?post_type=docs&#038;p=930"},"modified":"2025-09-29T21:37:35","modified_gmt":"2025-09-29T21:37:35","password":"","slug":"using-on-terminal","status":"publish","type":"docs","link":"https:\/\/protolinker.com\/en\/documentation\/using-on-terminal\/","title":{"rendered":"Using on terminal"},"content":{"rendered":"<p class=\"wp-block-paragraph \" style=\"\">You can start protolinker from your host operating system terminal without a user interface, that is a good approach for when, you already have the configuration file exported and want to run it on the production device.<\/p>\n\n\n<p class=\"wp-block-paragraph \" style=\"\">Each operating system will have some peculiarities to run the protolinker from the terminal, in most cases you will have to go to the folder where it is installed to be able to run it, or add to the operating system path.<br><br>Here are some of the command options for protolinker:<\/p>\n\n\n<pre class=\"wp-block-code\"><div class=\"copy-to-clipboard\">\n<span>Copied!<\/span><button class=\"click-to-copy-button\" title=\"Copy to clipboard\"><svg xmlns=\"http:\/\/www.w3.org\/2000\/svg\" viewbox=\"0 0 32 32\" stroke=\"currentcolor\" stroke-width=\"1.5\" stroke-linecap=\"round\" stroke-linejoin=\"round\" width=\"24\" height=\"24\" fill=\"none\">\n  <path d=\"M12.9975 10.7499L11.7475 10.7499C10.6429 10.7499 9.74747 11.6453 9.74747 12.7499L9.74747 21.2499C9.74747 22.3544 10.6429 23.2499 11.7475 23.2499L20.2475 23.2499C21.352 23.2499 22.2475 22.3544 22.2475 21.2499L22.2475 12.7499C22.2475 11.6453 21.352 10.7499 20.2475 10.7499L18.9975 10.7499Z\"><\/path>\n  <path d=\"M17.9975 12.2499L13.9975 12.2499C13.4452 12.2499 12.9975 11.8022 12.9975 11.2499L12.9975 9.74988C12.9975 9.19759 13.4452 8.74988 13.9975 8.74988L17.9975 8.74988C18.5498 8.74988 18.9975 9.19759 18.9975 9.74988L18.9975 11.2499C18.9975 11.8022 18.5498 12.2499 17.9975 12.2499Z\"><\/path>\n  <path d=\"M13.7475 16.2499L18.2475 16.2499\"><\/path>\n  <path d=\"M13.7475 19.2499L18.2475 19.2499\"><\/path>\n<\/svg><\/button><textarea>Usage: .\/protolinker [options]\nProtolinker - Protocol Integration Tool\n\nOptions:\n  -h, --help             Displays help on commandline options.\n  --help-all             Displays help, including generic Qt options.\n  -v, --version          Displays version information.\n  -m, --mode <mode>      Run mode: 'cli' or 'gui'.\n  --email <email>        User email for login.\n  --password <password>  Password for login.\n  --file <file>          Path to configuration JSON file.<\/file><\/password><\/email><\/mode><\/textarea>\n<\/div><code>Usage: .\/protolinker [options]\nProtolinker - Protocol Integration Tool\n\nOptions:\n  -h, --help             Displays help on commandline options.\n  --help-all             Displays help, including generic Qt options.\n  -v, --version          Displays version information.\n  -m, --mode &lt;mode&gt;      Run mode: 'cli' or 'gui'.\n  --email &lt;email&gt;        User email for login.\n  --password &lt;password&gt;  Password for login.\n  --file &lt;file&gt;          Path to configuration JSON file.<\/code><\/pre>\n\n\n<p class=\"wp-block-paragraph \" style=\"\">To start the CLI mode, without the user interface you need to use the -m cli, otherwise it will start as the default with the user interface, if you want you can pass all the necessary parameters at once when you call it from the command line or fill it up as it is requested from the application as well. You will need to inform your credentials for your protolinker account (email and password) and the file path to the configuration you want to run.<\/p>\n\n\n<p class=\"wp-block-paragraph \" style=\"\"><em><strong>Note<\/strong>: Once you input all of that the protolinker will create all of your protocols, tags, links and so on and will start the connections, so make sure you have everything connected to your machine before that.<\/em><\/p>\n\n\n<p class=\"wp-block-paragraph \" style=\"\"><em><strong>Note<\/strong>: On macOS, if you do not have it added on the path of your system, you will have to open the terminal inside the protolinker.app and go to contents\/MacOS to have access to the protolinker binary and run it from the terminal.<\/em><\/p>\n\n\n<p class=\"wp-block-paragraph \" style=\"\"><\/p>\n","protected":false},"excerpt":{"rendered":"<p>You can start protolinker from your host operating system terminal without a user interface, that is a good approach for when, you already have the configuration file exported and want to run it on the production device. Each operating system will have some peculiarities to run the protolinker from the terminal, in most cases you &hellip;<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"doc_category":[18],"doc_tag":[],"class_list":["post-930","docs","type-docs","status-publish","hentry","doc_category-configuration"],"year_month":"2026-07","word_count":313,"total_views":0,"reactions":{"happy":0,"normal":0,"sad":0},"author_info":{"name":"beraldoigor","author_nicename":"beraldoigor","author_url":"https:\/\/protolinker.com\/en\/author\/beraldoigor\/"},"doc_category_info":[{"term_name":"Configuration","term_url":"https:\/\/protolinker.com\/en\/docs-category\/configuration\/"}],"doc_tag_info":[],"_links":{"self":[{"href":"https:\/\/protolinker.com\/en\/wp-json\/wp\/v2\/docs\/930","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/protolinker.com\/en\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/protolinker.com\/en\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/protolinker.com\/en\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/protolinker.com\/en\/wp-json\/wp\/v2\/comments?post=930"}],"version-history":[{"count":0,"href":"https:\/\/protolinker.com\/en\/wp-json\/wp\/v2\/docs\/930\/revisions"}],"wp:attachment":[{"href":"https:\/\/protolinker.com\/en\/wp-json\/wp\/v2\/media?parent=930"}],"wp:term":[{"taxonomy":"doc_category","embeddable":true,"href":"https:\/\/protolinker.com\/en\/wp-json\/wp\/v2\/doc_category?post=930"},{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/protolinker.com\/en\/wp-json\/wp\/v2\/doc_tag?post=930"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}