https://github.com/free-ran-ue/frush
frush (free-ran-ue + shell) is a Bash-like interactive shell that provides a convenient interface for operating free-ran-ue and validating 5G core network, free5GC, behavior.
https://github.com/free-ran-ue/frush
bash cmd free-ran-ue free5gc interactive test
Last synced: 5 months ago
JSON representation
frush (free-ran-ue + shell) is a Bash-like interactive shell that provides a convenient interface for operating free-ran-ue and validating 5G core network, free5GC, behavior.
- Host: GitHub
- URL: https://github.com/free-ran-ue/frush
- Owner: free-ran-ue
- License: apache-2.0
- Created: 2026-01-20T12:39:22.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2026-01-26T15:37:30.000Z (5 months ago)
- Last Synced: 2026-01-27T20:31:34.159Z (5 months ago)
- Topics: bash, cmd, free-ran-ue, free5gc, interactive, test
- Language: Go
- Homepage:
- Size: 56.6 KB
- Stars: 2
- Watchers: 0
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-telco - frush - 04]` - Bash-like interactive shell for operating free-ran-ue and validating 5G core (free5GC) behavior. Companion: [fru-helm](https://github.com/free-ran-ue/fru-helm), [fru-compose](https://github.com/free-ran-ue/fru-compose). (Lab & Testbeds / Ready-to-Use Environments)
README
# frush
frush (free-ran-ue + shell) is a Bash-like interactive shell that provides a convenient interface for operating free-ran-ue and validating 5G core network, free5GC, behavior.
## free5GC Setting
Set N3 IP in `smfcfg.yaml` and `upfcfg.yaml` as `127.0.0.1`.
(Only these two fields shoud be modified!)
## Build frush
frush is developed under `go version go1.25.5 linux/amd64`. So make sure your environment has already installed go.
### Clone
```bash
git clone https://github.com/free-ran-ue/frush
```
### Make
```bash
cd frush
make
```
## Run frush
```bash
sudo ./frush
```
| frush CMD | Args | Description |
| - | - | - |
| help | - | Show help |
| exit | - | Exit |
| add | - | Add a subscriber to free5GC's webconsole |
| delete | - | Delete a subscriber from free5GC's webconsole |
| status | - | Show the status of gNB and UE |
| gnb | - | Start gNB |
| reg | - | Register UE to free5GC |
| dereg | - | De-register UE |
| ping | {IP} | Ping the DN, if dn is not provided, ping 1.1.1.1 and 8.8.8.8 |