-
Notifications
You must be signed in to change notification settings - Fork 13
Home
Freecli is an interactive cli utility to manage and test free5gc. It provides auto-completion and a variety of modules
- Hardware and Software requirements
- Download and build
- Configuration of Freecli
- Run Freecli
- Modules documentation
This project is tested against an Ubuntu 18.04 LTS VM with the linux kernel 5.0.23-generic. Check each module documentation for additional software requirements.
To compile into a binary file
git clone https://github.com/Srajdax/free5gc-cli.git
cd free5gc-cli
go mod download
go build -o freecli5G -x freecli.goRun it in sudo mode, QoS and gNB modules requires sudo privileges
sudo ./freecli5GFreecli uses free5gc lib under the hood with some modifications. Each freecli module is located into the module folder. Each module has its own configuration files located in the config folder. Each module is described below.
Each module is independent in freecli, at launch you can load the module by typing their name, e.g. to load the subscriber module and access all its functionalities:
sudo ./freecli5G
# Load the module
freecli> subscriber
2020-11-21T23:22:41Z [INFO][Freecli][Freecli] Loading subscriber module...
2020-11-21T23:22:41Z [INFO][Freecli][Subscriber Module] Successfully load module configuration config/subscriber.yaml
2020-11-21T23:22:41Z [INFO][Freecli][Subscriber Module] Successfully load ue configuration config/subscriber_ue.yaml
subscriber# The module is successfuly loaded
# Exit the module
subscriber# exit
2020-11-22T00:41:12+01:00 [INFO][Freecli][Freecli] Exiting Module...Modules are under developement and continious improvements but every command listed into the documentation has been tested, is stable and is safe to use.