gource

Gource is an OpenGL-based 3D visualisation tool for source control repositories

Options

NameDescription
-h, --helpHelp ('-H' for extended help)
--viewport <size>Set the viewport size. If -f is also supplied, will attempt to set the video mode to this also. Add `!` to make the window non-resizable
-fFullscreen
--screen <screen>Set the number of the screen to display on
--high-dpiRequest a high DPI display when creating the window. On some platforms such as MacOS, the window resolution is specified in points instead of pixels. The --high-dpi flag may be required to access some higher resolutions. E.g. requesting a high DPI 800x600 window may produce a window that is 1600x1200 pixels
--window-position <position>Initial window position on your desktop which may be made up of multiple monitors. This will override the screen setting so don't specify both
--framelessFrameless window
--transparentMake the background transparent. Only really useful for screenshots
--start-date <date>Start with the first entry after the supplied date and optional time. If a time zone offset isn't specified the local time zone is used. Example accepted formats: 'YYYY-MM-DD', 'YYYY-MM-DD hh:mm', 'YYYY-MM-DD hh:mm:ss +tz'
--stop-date <date>Stop at the last entry prior to the supplied date and optional time. Uses the same format as --start-date
-p, --start-position <position>Begin at some position in the log (between 0.0 and 1.0 or 'random')
--stop-position <position>Stop (exit) at some position in the log (does not work with STDIN)
-t, --stop-at-time <seconds>Stop (exit) after a specified number of seconds
--stop-at-endStop (exit) at the end of the log / stream
--loopLoop back to the start of the log when the end is reached
--loop-delay-seconds <seconds>Seconds to delay before looping
-a, --auto-skip-seconds <seconds>Automatically skip to next entry if nothing happens for a specified number of seconds
-s, --seconds-per-day <seconds>Speed of simulation in seconds per day
--realtimeRealtime playback speed
--no-time-travelUse the time of the last commit if the time of a commit is in the past
-c, --time-scaleChange simulation time scale
-i, --file-idle-timeTime in seconds files remain idle before they are removed or 0 for no limit
--file-idle-time-at-end <seconds>Time in seconds files remain idle at the end before they are removed
-e, --elasticity <elasticity>Elasticity of nodes
-b, --background-colour <colour>Background colour in hex
--background-image <image file>Set a background image
--title <title>Set a title
--font-file <font file>Specify the font. Should work with most font file formats supported by FreeType, such as TTF and OTF, among others
--font-scale <scale>Scale the size of all fonts
--font-size <size>Font size used by the date and title
--file-font-size <size>Font size of filenames
--dir-font-size <size>Font size of directory names
--user-font-size <size>Font size of user names
--font-colour <colour>Font colour used by the date and title in hex
--keyShow file extension key
--logo <image file>Logo to display in the foreground
--logo-offset <offset>Offset position of the logo
--date-format <format>Specify display date string (strftime format)
--log-command <command>Show the log command used by gource (git,svn,hg,bzr,cvs2cl)
--log-format <format>Specify format of the log being read (git,svn,hg,bzr,cvs2cl,custom). Required when reading from STDIN
--git-branch <branch>Get the git log of a branch other than the current one
--follow-user <username>Have the camera automatically follow a particular user
--highlight-dirsHighlight the names of all directories
--highlight-user <username>Highlight the names of a particular user
--highlight-usersHighlight the names of all users
--highlight-colour <colour>Font colour for highlighted users in hex
--selection-colour <colour>Font colour for selected users and files
--filename-colour <colour>Font colour for filenames
--dir-colour <color>Font colour for directories
--dir-name-depth <depth>Draw names of directories down to a specific depth in the tree
--dir-name-position <position>Position along edge of the directory name (between 0.1 and 1.0, default is 0.5)
--filename-time <time>Duration to keep filenames on screen (>= 2.0)
--file-extensionsShow filename extensions only
--file-extension-fallbackUse filename as extension if the extension is missing or empty
--file-filter <regex>Filter out file paths matching the specified regular expression
--file-show-filter <regex>Show only file paths matching the specified regular expression
--user-filter <regex>Filter usernames matching the specified regular expression
--user-show-filter <regex>Show only usernames matching the specified regular expression
--user-image-dir <directory>Directory containing .jpg or .png images of users (eg 'Full Name.png') to use as avatars
--default-user-image <User image>Path of .jpg to use as the default user image
--fixed-user-sizeForces the size of the user image to remain fixed throughout
--colour-imagesColourize user images
--crop <axis>Crop view on an axis (vertical,horizontal)
--padding <padding>Camera view padding
--multi-samplingEnable multi-sampling
--no-vsyncDisable vsync
--bloom-multiplier <multiplier>Adjust the amount of bloom
--bloom-intensity <intensity>Adjust the intensity of the bloom
--max-files <number>Set the maximum number of files or 0 for no limit. Excess files will be discarded
--max-file-lag <seconds>Max time files of a commit can take to appear. Use -1 for no limit
--max-user-speed <units>Max speed users can travel per second
--user-friction <seconds>Time users take to come to a halt
--user-scale <scale>Change scale of user avatars
--camera-mode <mode>Camera mode (overview,track)
--disable-auto-rotateDisable automatic camera rotation
--disable-inputDisable keyboard and mouse input
--hide <element...>Hide one or more display elements from the list below: bloom - bloom effect date - current date dirnames - names of directories files - file icons filenames - names of files mouse - mouse cursor progress - progress bar widget root - root directory of the tree tree - animated tree structure users - user avatars usernames - names of users
--hash-seed <seed>Change the seed of hash function
--caption-file <file>Caption file (see Caption Log Format)
--caption-size <size>Caption size
--caption-colour <colour>Caption colour in hex
--caption-duration <seconds>Caption duration
--caption-offset <offset>Caption horizontal offset (0 to centre captions)
-o, --output-ppm-stream <file>Output a PPM image stream to a file ('-' for STDOUT). This will automatically hide the progress bar initially and enable 'stop-at-end' unless other behaviour is specified
-r, --output-framerate <fps>Framerate of output (25,30,60). Used with --output-ppm-stream
--output-custom-log <file>Output a custom format log file ('-' for STDOUT)
--load-config <config file>Load a config file
--save-config <config file>Save a config file with the current options
--path <path>Either a supported version control directory, a pre-generated log file (see log commands or the custom log format), a Gource conf file or '-' to read STDIN