frtz

---

Access your FRITZ!Box configuration from the command line without using it's web UI.

• Usage
• Commands

Usage

$ npm install -g frtz
 
$ frtz setup # this saves your hostname, username and optionally password to the config file
$ frtz devices:list # list network devices
 
$ frtz --help devices:list
List both online and offline devices.
 
USAGE
  $ frtz devices:list
 
OPTIONS
  -P, --profile=profile    use a profile
  -h, --host=host          set hostname
  -p, --password=password  set password
  -s, --save               save output to dataDir
  -u, --user=user          set username
  -x, --extended           show extra columns
  --output=csv|json|yaml   output in a more machine friendly format
 
ALIASES
  $ frtz list
  $ frtz l
 
EXAMPLE
  $ frtz list -s -x -P work

Commands

• frtz config:profiles
• frtz config:show [TYPE]
• frtz devices:list
• frtz devices:wake DEVICE
• frtz help [COMMAND]
• frtz setup

frtz config:profiles

Lists the configured profiles

USAGE
  $ frtz config:profiles

OPTIONS
  -p, --showPassword  display password

ALIASES
  $ frtz listprofiles
  $ frtz profiles
  $ frtz lp

See code: src\commands\config\profiles.js

frtz config:show [TYPE]

Show the locations of config and cache files

USAGE
  $ frtz config:show [TYPE]

ARGUMENTS
  TYPE  (config|cache) [default: config] choose what to open

See code: src\commands\config\show.js

frtz devices:list

List both online and offline devices.

USAGE
  $ frtz devices:list

OPTIONS
  -P, --profile=profile    use a profile
  -h, --host=host          set hostname
  -p, --password=password  set password
  -s, --save               save output to dataDir
  -u, --username=username  set username
  -x, --extended           show extended output (ipv6, connection type)
  --active                 show only active devices
  --passive                show only passive devices

ALIASES
  $ frtz list
  $ frtz l

EXAMPLE
  $ frtz list -s -x -P work

See code: src\commands\devices\list.js

frtz devices:wake DEVICE

Wake a device from sleep with your FRITZ!Box

USAGE
  $ frtz devices:wake DEVICE

ARGUMENTS
  DEVICE  The device to wake. Can be IP address, hostname or mac address.

OPTIONS
  -P, --profile=profile    use a profile
  -h, --host=host          set hostname
  -p, --password=password  set password
  -u, --username=username  set username

ALIASES
  $ frtz wake
  $ frtz w

EXAMPLES
  $ frtz wake 127.0.0.1
  $ frtz w mycomputer

See code: src\commands\devices\wake.js

frtz help [COMMAND]

display help for frtz

USAGE
  $ frtz help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

frtz setup

Save configuration for fast access

USAGE
  $ frtz setup

OPTIONS
  -P, --profile=profile    save to a profile
  -h, --host=host          set hostname
  -p, --password=password  set password
  -u, --username=username  set username

DESCRIPTION
  Run the command without flags for interactive prompts or with flags to save them instantly.
  This saves:
  -Hostname
  -Username
  -Password (optional)

  You can also save it to a specific profile using -P.

See code: src\commands\setup.js