Added api doc about workspaces run command (#855)

This directly relates to yarnpkg/yarn#6244
yarnpkg · Oct 1, 2018 · 69a30e3 · 69a30e3
1 parent 5dcc21a
commit 69a30e3
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/lang/en/docs/cli/workspaces.md b/lang/en/docs/cli/workspaces.md
@@ -44,3 +44,19 @@ yarn workspaces vx.x.x
     "mismatchedWorkspaceDependencies": []
   }, ... }
 ```
+
+##### `yarn workspaces run <command>` <a class="toc" id="toc-yarn-workspaces-run" href="#toc-yarn-workspaces-run"></a>
+
+This will run the chosen Yarn command in each workspace.
+
+```sh
+yarn workspaces run test
+```
+
+This will invoke the test script for each workspace.
+
+This will also pass forward flags and can be useful for CI processes.
+
+```sh
+yarn workspaces run test --ci
+```