Skip to content

Commit

Permalink
docs(core): add view-logs description (#14775)
Browse files Browse the repository at this point in the history
  • Loading branch information
bcabanes committed Feb 3, 2023
1 parent b85f9de commit f38268b
Show file tree
Hide file tree
Showing 7 changed files with 70 additions and 2 deletions.
16 changes: 16 additions & 0 deletions docs/generated/cli/view-logs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: 'view-logs - CLI command'
description: 'Enables you to view and interact with the logs via the advanced analytic UI from Nx Cloud to help you debug your issue. To do this, Nx needs to connect your workspace to Nx Cloud and upload the most recent run details. Only the metrics are uploaded, not the artefacts.'
---

# view-logs

Enables you to view and interact with the logs via the advanced analytic UI from Nx Cloud to help you debug your issue. To do this, Nx needs to connect your workspace to Nx Cloud and upload the most recent run details. Only the metrics are uploaded, not the artefacts.

## Usage

```shell
nx view-logs
```

Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`.
8 changes: 8 additions & 0 deletions docs/generated/manifests/menus.json
Original file line number Diff line number Diff line change
Expand Up @@ -5273,6 +5273,14 @@
"isExternal": false,
"children": [],
"disableCollapsible": false
},
{
"name": "view-logs",
"path": "/packages/nx/documents/view-logs",
"id": "view-logs",
"isExternal": false,
"children": [],
"disableCollapsible": false
}
],
"isExternal": false,
Expand Down
11 changes: 11 additions & 0 deletions docs/generated/manifests/packages.json
Original file line number Diff line number Diff line change
Expand Up @@ -1847,6 +1847,17 @@
"path": "/packages/nx/documents/show",
"tags": [],
"originalFilePath": "generated/cli/show"
},
"/packages/nx/documents/view-logs": {
"id": "view-logs",
"name": "view-logs",
"description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.",
"file": "generated/packages/nx/documents/view-logs",
"itemList": [],
"isExternal": false,
"path": "/packages/nx/documents/view-logs",
"tags": [],
"originalFilePath": "generated/cli/view-logs"
}
},
"root": "/packages/nx",
Expand Down
11 changes: 11 additions & 0 deletions docs/generated/packages-metadata.json
Original file line number Diff line number Diff line change
Expand Up @@ -1825,6 +1825,17 @@
"path": "nx/documents/show",
"tags": [],
"originalFilePath": "generated/cli/show"
},
{
"id": "view-logs",
"name": "view-logs",
"description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.",
"file": "generated/packages/nx/documents/view-logs",
"itemList": [],
"isExternal": false,
"path": "nx/documents/view-logs",
"tags": [],
"originalFilePath": "generated/cli/view-logs"
}
],
"executors": [
Expand Down
16 changes: 16 additions & 0 deletions docs/generated/packages/nx/documents/view-logs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: 'view-logs - CLI command'
description: 'Enables you to view and interact with the logs via the advanced analytic UI from Nx Cloud to help you debug your issue. To do this, Nx needs to connect your workspace to Nx Cloud and upload the most recent run details. Only the metrics are uploaded, not the artefacts.'
---

# view-logs

Enables you to view and interact with the logs via the advanced analytic UI from Nx Cloud to help you debug your issue. To do this, Nx needs to connect your workspace to Nx Cloud and upload the most recent run details. Only the metrics are uploaded, not the artefacts.

## Usage

```shell
nx view-logs
```

Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`.
5 changes: 5 additions & 0 deletions docs/map.json
Original file line number Diff line number Diff line change
Expand Up @@ -1498,6 +1498,11 @@
"name": "show",
"id": "show",
"file": "generated/cli/show"
},
{
"name": "view-logs",
"id": "view-logs",
"file": "generated/cli/view-logs"
}
]
},
Expand Down
5 changes: 3 additions & 2 deletions packages/nx/src/command-line/nx-commands.ts
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ export const commandsObject = yargs
command: 'affected:libs',
deprecated:
'Use `nx print-affected --type=lib ...` instead. This command will be removed in v15.',
describe: `Print libraries affected by changes`,
describe: 'Print libraries affected by changes',
builder: (yargs) =>
linkToNxDevAndExamples(
withAffectedOptions(withPlainOption(yargs)),
Expand Down Expand Up @@ -369,7 +369,8 @@ export const commandsObject = yargs
})
.command({
command: 'view-logs',
describe: false,
describe:
'Enables you to view and interact with the logs via the advanced analytic UI from Nx Cloud to help you debug your issue. To do this, Nx needs to connect your workspace to Nx Cloud and upload the most recent run details. Only the metrics are uploaded, not the artefacts.',
handler: async () =>
process.exit(await (await import('./view-logs')).viewLogs()),
})
Expand Down

1 comment on commit f38268b

@vercel
Copy link

@vercel vercel bot commented on f38268b Feb 3, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

nx-dev – ./

nx-dev-git-master-nrwl.vercel.app
nx.dev
nx-five.vercel.app
nx-dev-nrwl.vercel.app

Please sign in to comment.