Command Line
The Netuno command-line interface is the main tool for managing your development environment. Through it, you can check system information, manage applications, and configure the server quickly.
Prerequisites
- Terminal: You must have a terminal (Command Prompt, PowerShell, or Bash) open in the root folder where Netuno was installed.
These are the initial commands to check whether your environment is ready for use.
| OPTION | DESCRIPTION |
|---|---|
help | Allows you to view all commands available in Netuno. |
version | Allows you to view the current Netuno version. |
List Available Commands
If you have questions about which operations you can perform, use the help command. It will return a complete list of functions.
./netuno help
View the Netuno Version
It is essential to know which version you are using to ensure compatibility with specific scripts and modules.
./netuno version
Install
Before starting development, you need to install the Netuno engine in your environment. For more information, visit our Installation page.
This section details the parameters that can be used during the installation process to automate or optimize the process.
| OPTION | DESCRIPTION |
|---|---|
checksum | Updates the verification code (checksum) of all files in the installed package. |
force | Forces replacement of all files, even if local changes exist. |
graal=true/false | Defines whether to use GraalVM to achieve higher performance when running applications. |
path=[directory] | Manually defines the path (folder) where Netuno will be installed. |
remove | Completely removes all Netuno-related files from the system. |
version=[version] | Selects a specific version to install. Use latest for the development version. |
yes | Automatically answers "YES" to all confirmations, ignoring warnings about data loss. |
Example of how to update the checksum:
./netuno install checksum
Example of how to force all local changes:
./netuno install force
Example of how to disable GraalVM:
./netuno install graal=false
GraalVM is active by default and is downloaded automatically during Netuno installation.
Example of how to set the installation path:
./netuno install path ='netunoDir'
Example of how to remove all Netuno folders:
./netuno install remove
Example of how to select the Netuno version to install:
./netuno install version='latest'
Example of how to answer YES to all questions:
./netuno install yes
Server
After completing the installation, start the server to begin developing your applications.
To start the server with the default settings, run the command below in the Netuno root folder:
./netuno server
By default, the server uses port 9000. As soon as the terminal indicates that the system is ready, you can access the management panel via the link: http://localhost:9000/
This section details the parameters that can be used during the server startup process.
| OPTION | DESCRIPTION |
|---|---|
app=[app_name] | Specifically defines which application should be started |
host=[IP/hostname] | Allows you to change the Netuno hostname |
launch=true/false | Defines whether Netuno should automatically open the browser |
npm | Automatically runs the 'npm watch' command to compile the application frontend in real time |
port=[number] | Defines the server startup port |
secret=[password] | Defines a security password to allow access to remote server management |
web=[folder] | Changes the predefined project root folder (web home) |
By default, Netuno uses the 'webapp' folder to store all files essential to its operation.
Attention when changing the directory: If you use the web=[folder] parameter to change the root folder name, remember that you must also physically rename the folder in your file system. The command only instructs the Netuno code on where to look for the files; it does not rename folders automatically.
Example of how to start the server for a specific application:
./netuno server app=myapp
Example of how to change the hostname (host):
./netuno server host=localhost
Example of how to define whether Netuno starts the browser automatically:
./netuno server launch=false
By default, Netuno opens the browser and launches the link http://localhost:9000.
Example of how to run npm to automatically build the frontend
./netuno server npm
Example of how to change the port:
./netuno server port=10000
Example of how to set a password to access remote server management:
./netuno server secret='p#ssw@rd'
Example of how to change the default web folder:
./netuno server web=webapp
License
To start development with Netuno, you must register your environment.
To manage your license, use the base command:
./netuno license
Currently, Netuno offers three license types: Community, Standard, and Enterprise.
This section details the actions available to configure or check your license.
| OPTION | DESCRIPTION |
|---|---|
create , change | Starts the process to create a new license or change the current one |
key | Displays the active license key in your environment |
mail=[your@mail.com] | Defines the email address associated with the license account |
type=[community/standard/enterprise] | Defines the license type |
Example of how to create a license:
./netuno license create
Example of how to view the license key:
./netuno license key
Example of how to set your email and license type:
./netuno license mail='mail@gmail.com' type='community'
Application
With the server configured and the license active, you can expand your ecosystem by creating new solutions.
./netuno app
The generated files will be automatically organized within the Netuno folder structure.
To access or edit your application files, navigate through the following path from the system root: webapp / apps / [your_app_name]
Folder Structure
-
webapp: It is the root folder that contains all files essential for Netuno to work.
-
apps: Specific folder where all developed or demo applications are stored.
-
[your_app_name]: The dedicated folder for the application you just created.
By default, Netuno has a demo application that is displayed when the Netuno server starts.
| OPTION | DESCRIPTION |
|---|---|
database=[database_name] | Defines the database name |
engine=[name] | Defines the database type |
host=[address] | Defines the database address. |
language=[language] | Defines the application language |
locale=[language] | Defines the application locale |
name=[name] | Allows you to create an application or rebuild an existing application |
password=[password] | Defines a database password |
port=[number] | Defines the database port |
username=[name] | Defines the database username |
Example of how to set the database name:
./netuno app database=employee
The database name can contain numbers and letters; if the name has more than one word, it must be separated by "_", as follows.
Example: employee_db
Example of how to set the database type:
./netuno app engine=pg
The following database types exist:
- PostgreSQL - pg
- MariaDB - mariadb
- Microsoft SQL Server - mssql
- H2 Database - h2
Example of how to set the database server address:
./netuno app host=localhost
Example of how to set the language and locale:
./netuno app language=pt_PT locale=pt_PT
The following languages exist:
- Portuguese - pt_PT
- Brazilian Portuguese - pt_BR
- English - en_US
- Spanish - es_ES
Example of how to create an application or rebuild an existing application:
./netuno app name=demo
Example of how to set the database password:
./netuno app password=secret
Example of how to set the database port:
./netuno app port=5432
By default, the ports correspond to:
- PostgreSQL - 5432
- MariaDB - 3306
- Microsoft SQL Server - 1433
Example of how to set the database username:
./netuno username=root