rana-cli/tests/samples/output/test_help_contents

63 lines
3.7 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]
[--entity-type ENTITY_TYPE] [--proxy PROXY] [--no-ssl-verify]
2016-04-28 21:57:15 +00:00
[--project PROJECT] [--alternate-project ALTERNATE_PROJECT]
[--language LANGUAGE] [--hostname HOSTNAME]
[--disable-offline] [--hide-filenames] [--exclude EXCLUDE]
[--include INCLUDE] [--include-only-with-project-file]
[--extra-heartbeats] [--log-file LOG_FILE] [--api-url 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
2017-02-15 23:02:05 +00:00
socks5://user:pass@host:port or domain\user:pass
--no-ssl-verify disables SSL certificate verification for HTTPS
requests. By default, SSL certificates are verified.
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
--language LANGUAGE optional language name; if valid, takes priority over
auto-detected language
2015-08-12 01:59:29 +00:00
--hostname HOSTNAME hostname of current machine.
--disable-offline disables offline time logging instead of queuing
2015-08-12 01:59:29 +00:00
logged time
--hide-filenames obfuscate filenames; will not send file names to api
2015-08-12 01:59:29 +00:00
--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
--include-only-with-project-file
disables tracking folders unless they contain a
.wakatime-project file; defaults to false
2016-04-20 22:30:44 +00:00
--extra-heartbeats reads extra heartbeats from STDIN as a JSON array
until EOF
--log-file LOG_FILE defaults to ~/.wakatime.log
--api-url 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