-
Notifications
You must be signed in to change notification settings - Fork 14
Home
Youssouf Drif edited this page Nov 25, 2020
·
14 revisions
Freecli is an interactive cli utility to manage and test free5gc. It currently includes the following modules:
- Subscriber: manage the subscriber of free5gc.
- 5G gNB: emulate a 5G gNB.
- QoS: apply DSCP PHB to packets.
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 freecli -x freecli.go
or to run it like an interpreter would do
git clone https://github.com/Srajdax/free5gc-cli.git
cd free5gc-cli
go run freecli.go
Freecli 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:
./freecli
# 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...