rana-cli/tests/samples/output/test_help_contents

59 lines
3.4 KiB
Text
Raw Normal View History

usage: wakatime [-h] [--entity FILE] [--key KEY] [--write] [--plugin PLUGIN]
2015-08-12 17:28:01 +00:00
[--time time] [--lineno LINENO] [--cursorpos CURSORPOS]
2016-04-28 21:57:15 +00:00
[--entity-type ENTITY_TYPE] [--proxy PROXY]
[--project PROJECT] [--alternate-project ALTERNATE_PROJECT]
[--alternate-language ALTERNATE_LANGUAGE]
[--hostname HOSTNAME] [--disableoffline] [--hidefilenames]
2016-04-20 22:30:44 +00:00
[--exclude EXCLUDE] [--include INCLUDE] [--extra-heartbeats]
[--logfile LOGFILE] [--apiurl API_URL] [--timeout TIMEOUT]
[--config CONFIG] [--verbose] [--version]
2015-08-12 01:59:29 +00:00
Common interface for the WakaTime api.
optional arguments:
-h, --help show this help message and exit
--entity FILE absolute path to file for the heartbeat; can also be a
2016-04-28 22:01:26 +00:00
url, domain, or app when --entity-type is not file
2015-08-12 01:59:29 +00:00
--key KEY your wakatime api key; uses api_key from
2016-04-26 11:40:08 +00:00
~/.wakatime.cfg by default
2015-08-12 01:59:29 +00:00
--write when set, tells api this heartbeat was triggered from
writing to a file
--plugin PLUGIN optional text editor plugin name and version for User-
Agent header
--time time optional floating-point unix epoch timestamp; uses
current time by default
--lineno LINENO optional line number; current line being edited
--cursorpos CURSORPOS
optional cursor position in the current file
2016-04-28 21:57:15 +00:00
--entity-type ENTITY_TYPE
entity type for this heartbeat. can be one of "file",
2016-04-28 21:57:15 +00:00
"domain", or "app"; defaults to file.
2016-05-21 11:09:55 +00:00
--proxy PROXY optional proxy configuration. Supports HTTPS and SOCKS
proxies. For example: https://user:pass@host:port or
socks5://user:pass@host:port
2015-08-12 01:59:29 +00:00
--project PROJECT optional project name
--alternate-project ALTERNATE_PROJECT
optional alternate project name; auto-discovered
project takes priority
--alternate-language ALTERNATE_LANGUAGE
optional alternate language name; auto-detected
languagetakes priority
2015-08-12 01:59:29 +00:00
--hostname HOSTNAME hostname of current machine.
--disableoffline disables offline time logging instead of queuing
logged time
--hidefilenames obfuscate file names; will not send file names to api
--exclude EXCLUDE filename patterns to exclude from logging; POSIX regex
syntax; can be used more than once
--include INCLUDE filename patterns to log; when used in combination
with --exclude, files matching include will still be
logged; POSIX regex syntax; can be used more than once
2016-04-20 22:30:44 +00:00
--extra-heartbeats reads extra heartbeats from STDIN as a JSON array
until EOF
2015-08-12 01:59:29 +00:00
--logfile LOGFILE defaults to ~/.wakatime.log
--apiurl API_URL heartbeats api url; for debugging with a local server
2015-09-15 16:03:41 +00:00
--timeout TIMEOUT number of seconds to wait when sending heartbeats to
2016-04-19 11:50:29 +00:00
api; defaults to 60 seconds
2016-04-26 11:40:08 +00:00
--config CONFIG defaults to ~/.wakatime.cfg
2015-08-12 01:59:29 +00:00
--verbose turns on debug messages in log file
--version show program's version number and exit