Skip to content

Commit 6d71d94

Browse files
authored
docs: update README.md (#1381)
Update cli section with latest `aegir --help`
1 parent 1c93163 commit 6d71d94

1 file changed

Lines changed: 36 additions & 16 deletions

File tree

README.md

Lines changed: 36 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -70,29 +70,49 @@ Run `aegir --help`
7070
Usage: aegir <command> [options]
7171

7272
Commands:
73-
aegir build Builds a browser bundle and TS type declarations from the `src` folder.
73+
aegir completion generate completion script
74+
aegir build Builds a browser bundle and TS type declara
75+
tions from the `src` folder.
76+
aegir check-project Ensure your project has the correct config.
7477
aegir check Check project
75-
aegir docs Generate documentation from TS type declarations.
76-
aegir doc-check Verify TS code snippets in documentation.
78+
aegir clean [files..] Remove created build artifacts.
79+
aegir dependency-check [input...] Run `dependency-check` cli with aegir defau
80+
lts. [aliases: dep-check, dep]
81+
aegir docs Generate documentation from TS type declara
82+
tions.
83+
aegir document-check [input...] Run `document-check` cli with aegir default
84+
s. [aliases: doc-check]
85+
aegir lint-package-json Lint package.json with aegir defaults.
86+
[aliases: lint-package, lpj]
7787
aegir lint Lint all project files
78-
aegir release Release your code onto the world
79-
aegir test-dependant [repo] Run the tests of an module that depends on this module to see if the current changes have caused a regression
88+
aegir release Release using semantic-release
89+
aegir release-rc Release an RC version of the current module
90+
or monorepo
91+
aegir test-dependant [repo] Run the tests of an module that depends on
92+
this module to see if the current changes h
93+
ave caused a regression
8094
aegir test Test your code in different environments
81-
aegir dependency-check [input...] Run `dependency-check` cli with aegir defaults. [aliases: dep-check, dep]
82-
aegir lint-package-json Lint package.json with aegir defaults. [aliases: lint-package, lpj]
83-
aegir completion generate completion script
95+
aegir exec <command> Run a command in each project of a monorepo
96+
aegir run <scripts..> Run one or more npm scripts in each project
97+
of a monorepo
8498

8599
Global Options:
86-
-h, --help Show help [boolean]
87-
-v, --version Show version number [boolean]
88-
-d, --debug Show debug output. [boolean] [default: false]
89-
--ts-repo Enable support for Typescript repos. [boolean] [default: false]
100+
-h, --help Show help [boolean]
101+
-v, --version Show version number [boolean]
102+
-d, --debug Show debug output. [boolean] [default: false]
90103

91104
Examples:
92-
aegir build Runs the build command to bundle JS code for the browser.
93-
npx aegir build Can be used with `npx` to use a local version
94-
aegir test -t webworker -- --browser firefox If the command supports `--` can be used to forward options to the underlying tool.
95-
npm test -- -- --browser firefox If `npm test` translates to `aegir test -t browser` and you want to forward options you need to use `-- --` instead.
105+
aegir build Runs the build command to bundle JS
106+
code for the browser.
107+
npx aegir build Can be used with `npx` to use a loca
108+
l version
109+
aegir test -t webworker -- --browser fir If the command supports `--` can be
110+
efox used to forward options to the under
111+
lying tool.
112+
npm test -- -- --browser firefox If `npm test` translates to `aegir t
113+
est -t browser` and you want to forw
114+
ard options you need to use `-- --`
115+
instead.
96116

97117
Use `aegir <command> --help` to learn more about each command.
98118
```

0 commit comments

Comments
 (0)