rana-cli/tests/samples/output/test_help_contents

83 lines
4.9 KiB
Text
Raw Normal View History

2015-08-12 01:59:29 +00:00
Common interface for the WakaTime api.
optional arguments:
-h, --help show this help message and exit
2018-04-07 05:37:01 +00:00
--entity FILE Absolute path to file for the heartbeat. Can also be a
2018-04-07 18:03:36 +00:00
url, domain or app when --entity-type is not file.
2018-04-07 05:37:01 +00:00
--key KEY Your wakatime api key; uses api_key from
~/.wakatime.cfg by default.
--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. This is the current line being
edited.
2015-08-12 01:59:29 +00:00
--cursorpos CURSORPOS
2018-04-07 05:37:01 +00:00
Optional cursor position in the current file.
2016-04-28 21:57:15 +00:00
--entity-type ENTITY_TYPE
2018-04-07 05:37:01 +00:00
Entity type for this heartbeat. Can be "file",
2018-04-07 18:03:36 +00:00
"domain" or "app". Defaults to "file".
2018-04-07 05:37:01 +00:00
--category CATEGORY Category of this heartbeat activity. Can be "coding",
2018-04-07 23:31:39 +00:00
"building", "indexing", "debugging", "running tests",
2018-12-04 03:28:18 +00:00
"writing tests", "manual testing", "code reviewing",
"browsing", or "designing". Defaults to "coding".
2018-04-07 05:37:01 +00:00
--proxy PROXY Optional proxy configuration. Supports HTTPS and SOCKS
2016-05-21 11:09:55 +00:00
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
2018-04-07 05:37:01 +00:00
--no-ssl-verify Disables SSL certificate verification for HTTPS
requests. By default, SSL certificates are verified.
--ssl-certs-file SSL_CERTS_FILE
Override the bundled Python Requests CA certs file. By
default, uses certifi for ca certs.
2018-04-07 05:37:01 +00:00
--project PROJECT Optional project name.
2015-08-12 01:59:29 +00:00
--alternate-project ALTERNATE_PROJECT
2018-04-07 05:37:01 +00:00
Optional alternate project name. Auto-discovered
project takes priority.
--language LANGUAGE Optional language name. If valid, takes priority over
auto-detected language.
--local-file FILE Absolute path to local file for the heartbeat. When
--entity is a remote file, this local file will be
used for stats and just the value of --entity sent
with heartbeat.
2018-04-07 05:37:01 +00:00
--hostname HOSTNAME Hostname of current machine.
--disable-offline Disables offline time logging instead of queuing
logged time.
--hide-file-names Obfuscate filenames. Will not send file names to api.
2018-07-18 08:01:31 +00:00
--hide-project-names Obfuscate project names. When a project folder is
detected instead of using the folder name as the
project, a .wakatime-project file is created with a
random project name.
2018-04-07 05:37:01 +00:00
--exclude EXCLUDE Filename patterns to exclude from logging. POSIX regex
syntax. Can be used more than once.
--exclude-unknown-project
When set, any activity where the project cannot be
detected will be ignored.
2018-04-07 05:37:01 +00:00
--include INCLUDE Filename patterns to log. When used in combination
2015-08-12 01:59:29 +00:00
with --exclude, files matching include will still be
2018-04-07 05:37:01 +00:00
logged. POSIX regex syntax. Can be used more than
once.
--include-only-with-project-file
2018-04-07 05:37:01 +00:00
Disables tracking folders unless they contain a
.wakatime-project file. Defaults to false.
--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.
--timeout TIMEOUT Number of seconds to wait when sending heartbeats to
api. Defaults to 60 seconds.
2018-09-20 16:08:09 +00:00
--sync-offline-activity SYNC_OFFLINE_ACTIVITY
Amount of offline activity to sync from your local
~/.wakatime.db sqlite3 file to your WakaTime Dashboard
before exiting. Can be "none" or a positive integer
number. Defaults to 5, meaning for every heartbeat
sent while online 5 offline heartbeats are synced. Can
be used without --entity to only sync offline activity
without generating new heartbeats.
2019-05-08 00:49:07 +00:00
--today Prints dashboard time for Today, then exits.
2018-04-07 05:37:01 +00:00
--config CONFIG Defaults to ~/.wakatime.cfg.
--verbose Turns on debug messages in log file.
2015-08-12 01:59:29 +00:00
--version show program's version number and exit