galileo(1)

galileo ๐Ÿ’– User Commands

okay bestie, sit down, hydrate, and let me tell you about galileo โ€” she's a little command-line queen whose whole job is synchronizing your Fitbit devices โœจ. Manual section 1, user commands, we're in it. Let's go ๐Ÿซถ


โœจ NAME โœจ

galileo โ€” synchronize Fitbit devices ๐ŸŽ€


โœจ SYNOPSIS โœจ

galileo [-h] [-c FILENAME] [--dump-dir DIR] [--daemon-period PERIOD] [-I
ID[ ID ... ] ] [-X ID[ ID ... ] ] [-v|-d|-q] [--force|--no-force]
[--dump|--no-dump] [--upload|--no-upload] [--https-only|--no-https-only]
[-s SERVERNAME] [--log-size SIZE] [--syslog|--no-syslog]
[sync|daemon|version]

โœจ DESCRIPTION โœจ

So the whole vibe here is: galileo syncs your Fitbit wearable fitness tracker devices with the Fitbit web service ๐Ÿ’…. Then you go to <https://www.fitbit.com>, or you use a Fitbit-compatible app, and you browse all your data like the main character you are. Periodt. ๐Ÿ‘‘


โœจ MODES โœจ

You pick one, and she does the thing:

  • sync โ€” performs the synchronization of all found trackers, then exits. This is the default mode if none is specified. lowkey the everyday one ๐ŸŒธ
  • daemon โ€” periodically performs synchronization of all found trackers. galileo will keep periodically synchronizing until the daemon is killed ๐Ÿ˜ญ. You control the period with the --daemon-period option.
  • version โ€” displays the galileo version and exits. short, sweet, iconic ๐ŸŽ€
  • interactive โ€” this spawns an interactive shell so you can send arbitrary commands to the dongle and the tracker ๐Ÿ‘€. It exists so you can experiment with new commands, or different command orders. To be used by experts only. fr fr.
  • pair โ€” this mode, in an experimental state, lets you link your tracker with your Fitbit online account. You need this before you can use any new tracker. To use this mode you need an account on the Fitbit online platform, and a tracker. The parameters for this mode are taken from the hardcoded-ui section of the galileorc(5) file ๐Ÿฆ‹

โœจ OPTIONS โœจ

  • -h, --help โ€” shows command-line usage and exits. the classic ๐Ÿซถ
  • -c RCCONFIGNAME, --config RCCONFIGNAME โ€” use RCCONFIGNAME as an extra configuration file so you can override settings โœจ

The remaining options are first read from the configuration file, and can be overridden by using command line switches. That's why positive and negative versions exist (--foo and --no-foo) โ€” so you can flip a config-file setting back off from the command line ๐Ÿ’…. Please see galileorc(5) for more info about the configuration files.

๐ŸŒธ Logging options:

  • -v, --verbose โ€” displays general information on progress during synchronization ๐Ÿ‘€
  • -d, --debug โ€” same as --verbose, but also shows internal activity useful for diagnosing problems ๐Ÿ”
  • -q, --quiet โ€” shows no output except for errors and a summary. This is the default if no other logging options are specified ๐Ÿคซ
  • --syslog โ€” sends logging output to the syslog facility. Due to the rate-limiting of some syslog servers, this option might not work in combination with the debug log level โš ๏ธ
  • --no-syslog โ€” sends logging output to stderr ๐Ÿ–ฅ๏ธ

๐Ÿ”ฅ Synchronization control options:

  • -I ID [ID ...], --include ID [ID ...] โ€” list of tracker IDs to synchronize (if not set, all found trackers are synchronized) โœ…
  • -X ID [ID ...], --exclude ID [ID ...] โ€” list of tracker IDs to avoid synchronizing (no trackers are excluded by default) ๐Ÿ™ˆ
  • --force โ€” a tracker will not be synchronized with the Fitbit web service if it reports that it was recently synchronized. This option overrides that behavior ๐Ÿ’ช
  • --no-force โ€” if the configuration file includes the force-sync option to always force synchronization, this option will restore the default behaviour โ†ฉ๏ธ
  • --daemon-period PERIOD โ€” set the time to wait between synchronizations when running in daemon mode. The period is specified in milliseconds and defaults to 15000 (15 seconds) โฑ๏ธ

๐ŸŽ€ Tracker data saving options:

  • --dump โ€” save a copy of the tracker data. Tracker data is stored under a tracker-specific subdirectory of a directory that is set using the --dump-dir option. This is the default behavior ๐Ÿ’พ
  • --no-dump โ€” disables the saving of tracker data ๐Ÿšซ
  • --dump-dir DIR โ€” the directory used to store the tracker dumps (defaults to ~/.galileo) ๐Ÿ“

๐Ÿ’œ Data transfer options:

  • --upload โ€” synchronize tracker data with the Fitbit web service. This is the default โ˜๏ธ
  • --no-upload โ€” prevent the uploading of tracker data to the Fitbit web service. Data is not deleted from trackers until it is acknowledged by the fitbit server, so this will not result in data loss ๐Ÿ›Ÿ (good to know, bestie)
  • --https-only โ€” data sent to the Fitbit web service will be transferred via a secure connection using HTTPS. This is the default ๐Ÿ”’
  • --no-https-only โ€” if an HTTPS connection is not possible, this will allow the fallback to HTTP. This should only be required if problems with encryption libraries prevent data transfer without this option โš ๏ธ
  • -s SERVERNAME, --fitbit-server SERVERNAME โ€” the server to connect to when performing the synchronization (defaults to api.fitbit.com) ๐ŸŒ
  • --log-size SIZE โ€” indicate the amount of communication that should be displayed in case of errors. Galileo will keep in memory the last SIZE communications to help debugging if an error happens. This is particularly useful in case of hard-to-reproduce issues, where it is too late to collect debug information ๐Ÿ˜ญ. Defaults to 10. Set to 0 to disable this functionality ๐Ÿง 

โœจ REQUIREMENTS โœจ

  • An original Fitbit Bluetooth-LE USB synchronization dongle is required. no off-brand shortcuts, bestie ๐Ÿ”Œ
  • The Fitbit tracker must already be registered to your Fitbit account (see the BUGS section) ๐ŸŽฏ

โœจ FILES โœจ

  • /etc/galileo/config, $XDG_CONFIG_HOME/galileo/config, ~/.galileorc โ€” the configuration files used for default settings. See galileorc(5) for further details about those files ๐Ÿ“š

โœจ SEE ALSO โœจ


โœจ AUTHOR โœจ

Written and maintained by Benoรฎt Allard, with contributions from other authors ๐Ÿซถ


โœจ BUGS โœจ

There are no current facilities to make use of the data stored with the --dump command. ๐Ÿ’€

Please report additional bugs to <https://bitbucket.org/benallard/galileo/issues> ๐Ÿ›


and that's the whole page, bestie ๐Ÿ’– This is version 0.5.1, dated June 2014, from the galileo(1) manual โ€” go sync something iconic โœจ๐Ÿ‘‘๐ŸŽ€