Skip to content

Commit 859a1e7

Browse files
kleisaukethomasrockhu-codecov
kleisauke
and
thomasrockhu-codecov
authored
chore: update HELPFILE (#1037)
* chore: update HELPFILE * Update HELPFILE * Update HELPFILE --------- Co-authored-by: Tom Hu <[email protected]>
1 parent 33d4dc8 commit 859a1e7

File tree

1 file changed

+80
-43
lines changed

1 file changed

+80
-43
lines changed

‎HELPFILE

Lines changed: 80 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,81 @@
1+
Usage: codecov <command> [options]
2+
13
Options:
2-
-b, --build Specify the build number manually
3-
-B, --branch Specify the branch manually
4-
-e, --env Specify environment variables to be included with this build.
5-
Also accepting environment variables: CODECOV_ENV=VAR,VAR2
6-
-C, --sha Specify the commit SHA manually
7-
-f, --file Target file(s) to upload
8-
-F, --flags Flag the upload to group coverage metrics [default: ""]
9-
-n, --name Custom defined name of the upload. Visible in Codecov UI
10-
[default: ""]
11-
-N, --parent The commit SHA of the parent for which you are uploading
12-
coverage. If not present, the parent will be determined using
13-
the API of your repository provider. When using the repository
14-
provider's API, the parent is determined via finding the
15-
closest ancestor to the commit.
16-
-P, --pr Specify the pull request number manually
17-
-s, --dir Directory to search for coverage reports.
18-
Already searches project root and current working directory
19-
-t, --token Codecov upload token [default: ""]
20-
-T, --tag Specify the git tag [default: ""]
21-
-v, --verbose Run with verbose logging [boolean]
22-
-R, --rootDir Specify the project root directory when not in a git repo
23-
-Z, --nonZero Should errors exit with a non-zero (default: false)
24-
[boolean] [default: false]
25-
-d, --dryRun Don't upload files to Codecov [boolean]
26-
-r, --slug Specify the slug manually
27-
-u, --url Change the upload host (Enterprise use)
28-
[string] [default: "https://codecov.io"]
29-
-c, --clean Move discovered coverage reports to the trash
30-
[boolean] [default: false]
31-
-X, --feature Toggle functionalities.
32-
Separate multiple ones by comma: -X network,search
33-
-X network Disable uploading the file network
34-
-X search Disable searching for coverage files
35-
[string]
36-
-Q, --source Used internally by Codecov, this argument helps track wrappers
37-
of the uploader (e.g. GitHub Action, CircleCI Orb)
38-
[string] [default: ""]
39-
--gcov Run with gcov support [boolean] [default: false]
40-
--gcovIgnore Paths to ignore during gcov gathering [string]
41-
--gcovInclude Paths to include during gcov gathering [string]
42-
--gcovArgs Extra arguments to pass to gcov [string]
43-
--version Show version number [boolean]
44-
-h, --help Show help [boolean]
4+
-B, --branch Specify the branch manually [string]
5+
-b, --build Specify the build number manually [number]
6+
-c, --clean Move discovered coverage reports to the trash
7+
[boolean] [default: false]
8+
-C, --sha Specify the commit SHA manually [string]
9+
--changelog, --CL Display a link for the current changelog
10+
[boolean] [default: false]
11+
-d, --dryRun Don't upload files to Codecov
12+
[boolean] [default: false]
13+
-e, --env Specify environment variables to be included
14+
with this build.
15+
Also accepting environment variables:
16+
CODECOV_ENV=VAR,VAR2
17+
-f, --file Target file(s) to upload [string]
18+
--fullReport, --full Specify the path to a previously uploaded
19+
Codecov report [string]
20+
-F, --flags Flag the upload to group coverage metrics
21+
[string] [default: ""]
22+
-g, --gcov Run with gcov support [boolean] [default: false]
23+
--gcovArgs, --ga Extra arguments to pass to gcov [string]
24+
--gcovIgnore, --gi Paths to ignore during gcov gathering [string]
25+
--gcovInclude, --gI Paths to include during gcov gathering [string]
26+
--gcovExecutable, --gx gcov executable to run. Defaults to 'gcov'
27+
[string]
28+
-i, --networkFilter Specify a filter on the files listed in the
29+
network section of the Codecov report. Useful
30+
for upload-specific path fixing [string]
31+
-k, --networkPrefix Specify a prefix on files listed in the network
32+
section of the Codecov report. Useful to help
33+
resolve path fixing [string]
34+
-n, --name Custom defined name of the upload. Visible in
35+
Codecov UI [string] [default: ""]
36+
-N, --parent The commit SHA of the parent for which you are
37+
uploading coverage. If not present, the parent
38+
will be determined using the API of your
39+
repository provider. When using the repository
40+
provider's API, the parent is determined via
41+
finding the closest ancestor to the commit.
42+
[string]
43+
-P, --pr Specify the pull request number manually[number]
44+
-Q, --source Used internally by Codecov, this argument helps
45+
track
46+
wrappers of the uploader (e.g. GitHub Action,
47+
CircleCI Orb) [string] [default: ""]
48+
-R, --rootDir Specify the project root directory when not in a
49+
git repo
50+
-r, --slug Specify the slug manually [string] [default: ""]
51+
-s, --dir Directory to search for coverage reports.
52+
Already searches project root and current
53+
working directory [string]
54+
-T, --tag Specify the git tag [string] [default: ""]
55+
-t, --token Codecov upload token [string] [default: ""]
56+
-U, --upstream The upstream http proxy server to connect
57+
through [string] [default: ""]
58+
-u, --url Change the upload host (Enterprise use)
59+
[string] [default: "https://codecov.io"]
60+
-v, --verbose Run with verbose logging [boolean]
61+
-X, --feature Toggle functionalities. Separate multiple ones
62+
by comma: -X network,search
63+
-X fixes Enable file fixes to ignore
64+
common lines from coverage (e.g. blank lines or
65+
empty brackets)
66+
-X network Disable uploading the file
67+
network
68+
-X search Disable searching for coverage
69+
files [string]
70+
--xcode, --xc, --xc Deprecating, please use xs] Run with xcode
71+
support [boolean] [default: false]
72+
--xcodeArchivePath, --xp [Deprecating, please use xs] Specify the xcode
73+
archive path. Likely specified as the
74+
-resultBundlePath and should end in .xcresult
75+
[string]
76+
--swift, --xs Run with swift support[boolean] [default: false]
77+
--swiftProject, --xsp Specify the swift project [string] [default: ""]
78+
-Z, --nonZero Should errors exit with a non-zero (default:
79+
false) [boolean] [default: false]
80+
--version Show version number [boolean]
81+
-h, --help Show help [boolean]

0 commit comments

Comments
 (0)