Connecting via Command Line

You can connect to your MySQL database using our command line interface.

> npx @outerbase/studiomysql://root:123@localhost:3306/chinook
                                              
    Serving!                                  
    - Local:    http://localhost:4000         
    - Network:  http://xxx.xxx.xxx.xxx:4000    
                                              

You can also configure the port and secure it with authentication.

> npx @outerbase/studio \
--port=5000 \
--user=admin --pass=123 \
mysql://root:123@localhost:3306/chinook

Configuration File

Tired of typing long connection strings repeatedly? Simply save the configuration to a file and use it whenever needed. Create outerbase.json

{
  "driver": "mysql",
  "connection": {
    "database": "chinook",
    "host": "localhost",
    "port": 3306,
    "user": "root",
    "password": "123456"
  }
}

Next, run our command line tool to start the service. By default, it will search for the outerbase.json configuration file. Alternatively, you can specify a custom configuration using the --config flag.

> npx @outerbase/studio