Installation and Usage

Installation and Usage#

With Docker Compose#

Use the Bialet Skeleton repository or the framework repository to start Docker Compose the application.

Customizing the Application Directory#

To specify a custom directory for the Bialet project, set the BIALET_DIR environment variable:

BIALET_DIR=/path/to/app docker compose up

Changing the Default Port#

The default application port is 7000. To use a different port, set the BIALET_PORT environment variable:

BIALET_PORT=7001 docker compose up

Building from Source#

To build Bialet from source, you’ll need to install certain dependencies and run the build process.

Dependencies#

Debian/Ubuntu#

sudo apt install -y libsqlite3-dev libssl-dev libcurl4-openssl-dev

MacOS#

brew install sqlite3 openssl curl

Windows#

  • libcrypto-3-x64.dll

  • libsqlite3-0.dll

  • libssl-3-x64.dll

Building the Project#

After installing the dependencies, compile the project:

make clean && make

To install the built application, run:

make install

Syntax Highlighting#

You have available the plugin for Vim/Neovim.

Plug 'bialet/bialet.vim'

We are still working on supporting VSCode and other IDEs.

Using the Bialet CLI#

The Bialet CLI allows you to interact with the application directly from the command line.

Basic Usage#

To start the application, simply run:

bialet

By default, the application runs in the current directory.

Customizing Startup Options#

To change the directory where the application runs or adjust other settings, you can use various command-line arguments:

bialet -p 7000 /path/to/app

CLI Parameters#

The table below summarizes the available command-line parameters for the Bialet CLI:

Parameter

Description

Default Value

-p

Port number

7000

-h

Host name

localhost

-r

Run the code passed as argument

None

-l

Log file location

stdout

-d

SQLite database file location

_db.sqlite

-i

Ignored files, comma separated list of glob expressions

README*, LICENSE* , *.json, *.yml, *.yaml

-m

Memory limit (MB)

50

-M

Hard memory limit (MB)

100

-c

CPU limit (%)

15

-C

Hard CPU limit (%)

30

Run code from the Command Line#

To run code from the command line, use the -r command:

bialet -r 'System.print("Hello, World!")'

The response will be printed directly.

bialet -r 'import "bialet" for Response
Response.out("No log, plain response")'

You have to respect new lines in the code.

Contents