All pages
Powered by GitBook
1 of 6

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Commands

Integrating CommandBox with your own ForgeBox endpoint is very simple. Please review the available commands and follow our guide to learn how to interact with ForgeBox from the CLI.

This is a list of the commands you have available to integrate with ForgeBox enterprise.

  • forgebox endpoint list

  • forgebox endpoint register

  • forgebox endpoint remove

  • forgebox endpoint set-default

You can always ask CommandBox for help by adding a question mark at the end of your command. example: forgebox endpoint ?

Register

In order to register a new endpoint, just give it a name and set your endpoint as follows: forgebox endpoint register stg-forgebox https://forgebox.stg.ortushq.com/api/v1/

Login

The next step is to authenticate against your endpoint using valid credentials as is shown below: forgebox login endpointName=stg-forgebox

Enter your username and password and make sure you authenticate successfully.

Set Default

If you want to update your endpoint to be the default one, just do it like this: forgebox endpoint set-default stg-forgebox

This will default your endpoint and you will be able to install packages from your endpoint without giving a namespace.

You can verify that your default endpoint has changed by executing the list command.

Remove

You can remove endpoints anytime by using the remove command: forgebox endpoint remove demo-endpoint

List

https://www.forgebox.io/api/v1/ is the default endpoint and you can always check your registered endpoints by typing forgebox endpoint list