Access your Arris TG3442DE or Technicolor CGA4322DE, CGA6444VF (aka Vodafone Station) from the comfort of the command line.
![](./usage.svg)
Currently the following hardware/software is supported:
AR01.02.068.11_092320_711.PC20.10
, 01.02.068.13.EURO.PC20
1.0.9-IMS-KDG
, 2.0.17-IMS-KDG
, 3.0.41-IMS-KDG
19.3B57-1.0.41
A full login and logout sequence is being done on every command execution.
You can provide a password either by setting the environment variable VODAFONE_ROUTER_PASSWORD
in your shell, in a local .env
file or by using the -p
flag.
Cable connection information/meaning:
The Diagnose module is based on the guidelines/values provided by Meister Voda:
Clone this repository, install the dependencies via yarn and run ./bin/dev help
.
If you are interested in seeing a more verbose version of what is going on during execution, enable debug logging on a per command basis like so env DEBUG=\* ./bin/dev docsis
.
$ npm install -g vodafone-station-cli
$ vodafone-station-cli COMMAND
running command...
$ vodafone-station-cli (--version)
vodafone-station-cli/1.2.10 darwin-arm64 node-v22.6.0
$ vodafone-station-cli --help [COMMAND]
USAGE
$ vodafone-station-cli COMMAND
...
vodafone-station-cli diagnose
vodafone-station-cli discover
vodafone-station-cli docsis
vodafone-station-cli help [COMMAND]
vodafone-station-cli host-exposure disable [ENTRIES]
vodafone-station-cli host-exposure enable [ENTRIES]
vodafone-station-cli host-exposure get
vodafone-station-cli host-exposure set FILE
vodafone-station-cli plugins
vodafone-station-cli plugins add PLUGIN
vodafone-station-cli plugins:inspect PLUGIN...
vodafone-station-cli plugins install PLUGIN
vodafone-station-cli plugins link PATH
vodafone-station-cli plugins remove [PLUGIN]
vodafone-station-cli plugins reset
vodafone-station-cli plugins uninstall [PLUGIN]
vodafone-station-cli plugins unlink [PLUGIN]
vodafone-station-cli plugins update
vodafone-station-cli restart
vodafone-station-cli diagnose
Diagnose the quality of the docsis connection.
USAGE
$ vodafone-station-cli diagnose [-p <value>] [-w]
FLAGS
-p, --password=<value> router/modem password
-w, --web review the docsis values in a webapp
DESCRIPTION
Diagnose the quality of the docsis connection.
EXAMPLES
$ vodafone-station-cli diagnose
See code: src/commands/diagnose.ts
vodafone-station-cli discover
Try to discover a cable modem in the network
USAGE
$ vodafone-station-cli discover
DESCRIPTION
Try to discover a cable modem in the network
EXAMPLES
$ vodafone-station-cli discover
See code: src/commands/discover.ts
vodafone-station-cli docsis
Get the current docsis status as reported by the modem in a JSON format.
USAGE
$ vodafone-station-cli docsis [-p <value>] [-f] [-w]
FLAGS
-f, --file write out a report file under ./reports/${CURRENT_UNIX_TIMESTAMP}_docsisStatus.json
-p, --password=<value> router/modem password
-w, --web review the docsis values in a webapp
DESCRIPTION
Get the current docsis status as reported by the modem in a JSON format.
EXAMPLES
$ vodafone-station-cli docsis -p PASSWORD
{JSON data}
See code: src/commands/docsis.ts
vodafone-station-cli help [COMMAND]
Display help for vodafone-station-cli.
USAGE
$ vodafone-station-cli help [COMMAND...] [-n]
ARGUMENTS
COMMAND... Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for vodafone-station-cli.
See code: @oclif/plugin-help
vodafone-station-cli host-exposure disable [ENTRIES]
Disable a set of host exposure entries
USAGE
$ vodafone-station-cli host-exposure disable [ENTRIES...] [-p <value>]
ARGUMENTS
ENTRIES... Host exposure entries to disable. Pass no names to disable every existing entry.
FLAGS
-p, --password=<value> router/modem password
DESCRIPTION
Disable a set of host exposure entries
EXAMPLES
$ vodafone-station-cli host-exposure:disable -p PASSWORD [ENTRY NAME | [ENTRY NAME...]]
See code: src/commands/host-exposure/disable.ts
vodafone-station-cli host-exposure enable [ENTRIES]
Enable a set of host exposure entries
USAGE
$ vodafone-station-cli host-exposure enable [ENTRIES...] [-p <value>]
ARGUMENTS
ENTRIES... Host exposure entries to enable. Pass no names to enable every existing entry.
FLAGS
-p, --password=<value> router/modem password
DESCRIPTION
Enable a set of host exposure entries
EXAMPLES
$ vodafone-station-cli host-exposure:enable -p PASSWORD [ENTRY NAME | [ENTRY NAME...]]
See code: src/commands/host-exposure/enable.ts
vodafone-station-cli host-exposure get
Get the current IPV6 host exposure settings
USAGE
$ vodafone-station-cli host-exposure get [-p <value>]
FLAGS
-p, --password=<value> router/modem password
DESCRIPTION
Get the current IPV6 host exposure settings
EXAMPLES
$ vodafone-station-cli host-exposure:get -p PASSWORD
{JSON data}
See code: src/commands/host-exposure/get.ts
vodafone-station-cli host-exposure set FILE
Set the current IPV6 host exposure settings from a JSON file
USAGE
$ vodafone-station-cli host-exposure set FILE [-p <value>]
ARGUMENTS
FILE input JSON file
FLAGS
-p, --password=<value> router/modem password
DESCRIPTION
Set the current IPV6 host exposure settings from a JSON file
EXAMPLES
$ vodafone-station-cli host-exposure:set -p PASSWORD <FILE>
See code: src/commands/host-exposure/set.ts
vodafone-station-cli plugins
List installed plugins.
USAGE
$ vodafone-station-cli plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ vodafone-station-cli plugins
See code: @oclif/plugin-plugins
vodafone-station-cli plugins add PLUGIN
Installs a plugin into vodafone-station-cli.
USAGE
$ vodafone-station-cli plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]
ARGUMENTS
PLUGIN... Plugin to install.
FLAGS
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
-h, --help Show CLI help.
-s, --silent Silences npm output.
-v, --verbose Show verbose npm output.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Installs a plugin into vodafone-station-cli.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the VODAFONE_STATION_CLI_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the VODAFONE_STATION_CLI_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ vodafone-station-cli plugins add
EXAMPLES
Install a plugin from npm registry.
$ vodafone-station-cli plugins add myplugin
Install a plugin from a github url.
$ vodafone-station-cli plugins add https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ vodafone-station-cli plugins add someuser/someplugin
vodafone-station-cli plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ vodafone-station-cli plugins inspect PLUGIN...
ARGUMENTS
PLUGIN... [default: .] Plugin to inspect.
FLAGS
-h, --help Show CLI help.
-v, --verbose
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Displays installation properties of a plugin.
EXAMPLES
$ vodafone-station-cli plugins inspect myplugin
See code: @oclif/plugin-plugins
vodafone-station-cli plugins install PLUGIN
Installs a plugin into vodafone-station-cli.
USAGE
$ vodafone-station-cli plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]
ARGUMENTS
PLUGIN... Plugin to install.
FLAGS
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
-h, --help Show CLI help.
-s, --silent Silences npm output.
-v, --verbose Show verbose npm output.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Installs a plugin into vodafone-station-cli.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the VODAFONE_STATION_CLI_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the VODAFONE_STATION_CLI_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ vodafone-station-cli plugins add
EXAMPLES
Install a plugin from npm registry.
$ vodafone-station-cli plugins install myplugin
Install a plugin from a github url.
$ vodafone-station-cli plugins install https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ vodafone-station-cli plugins install someuser/someplugin
See code: @oclif/plugin-plugins
vodafone-station-cli plugins link PATH
Links a plugin into the CLI for development.
USAGE
$ vodafone-station-cli plugins link PATH [-h] [--install] [-v]
ARGUMENTS
PATH [default: .] path to plugin
FLAGS
-h, --help Show CLI help.
-v, --verbose
--[no-]install Install dependencies after linking the plugin.
DESCRIPTION
Links a plugin into the CLI for development.
Installation of a linked plugin will override a user-installed or core plugin.
e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
command will override the user-installed or core plugin implementation. This is useful for development work.
EXAMPLES
$ vodafone-station-cli plugins link myplugin
See code: @oclif/plugin-plugins
vodafone-station-cli plugins remove [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ vodafone-station-cli plugins remove [PLUGIN...] [-h] [-v]
ARGUMENTS
PLUGIN... plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ vodafone-station-cli plugins unlink
$ vodafone-station-cli plugins remove
EXAMPLES
$ vodafone-station-cli plugins remove myplugin
vodafone-station-cli plugins reset
Remove all user-installed and linked plugins.
USAGE
$ vodafone-station-cli plugins reset [--hard] [--reinstall]
FLAGS
--hard Delete node_modules and package manager related files in addition to uninstalling plugins.
--reinstall Reinstall all plugins after uninstalling.
See code: @oclif/plugin-plugins
vodafone-station-cli plugins uninstall [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ vodafone-station-cli plugins uninstall [PLUGIN...] [-h] [-v]
ARGUMENTS
PLUGIN... plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ vodafone-station-cli plugins unlink
$ vodafone-station-cli plugins remove
EXAMPLES
$ vodafone-station-cli plugins uninstall myplugin
See code: @oclif/plugin-plugins
vodafone-station-cli plugins unlink [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ vodafone-station-cli plugins unlink [PLUGIN...] [-h] [-v]
ARGUMENTS
PLUGIN... plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ vodafone-station-cli plugins unlink
$ vodafone-station-cli plugins remove
EXAMPLES
$ vodafone-station-cli plugins unlink myplugin
vodafone-station-cli plugins update
Update installed plugins.
USAGE
$ vodafone-station-cli plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
See code: @oclif/plugin-plugins
vodafone-station-cli restart
Restart the router/modem
USAGE
$ vodafone-station-cli restart [-p <value>]
FLAGS
-p, --password=<value> router/modem password
DESCRIPTION
Restart the router/modem
EXAMPLES
$ vodafone-station-cli restart -p PASSWORD
See code: src/commands/restart.ts