Skip to content

Commit

Permalink
docs(docs): move nx console page under cli (nrwl#2881)
Browse files Browse the repository at this point in the history
* docs(docs): move nx console page under cli

* Update docs/shared/console.md

Co-Authored-By: Brandon <[email protected]>

* docs(docs): update docs/shared/console.md

Co-Authored-By: Brandon <[email protected]>

* docs(docs): update docs/shared/console.md

Co-authored-by: Isaac Mann <[email protected]>
Co-authored-by: Brandon <[email protected]>
  • Loading branch information
3 people authored Apr 21, 2020
1 parent 7b42285 commit 6672e56
Show file tree
Hide file tree
Showing 4 changed files with 60 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/map.json
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,11 @@
"id": "overview",
"file": "angular/guides/cli-overview"
},
{
"name": "Console",
"id": "console",
"file": "shared/console"
},
{
"name": "generate",
"id": "generate",
Expand Down Expand Up @@ -942,6 +947,11 @@
"id": "overview",
"file": "react/guides/cli-overview"
},
{
"name": "Console",
"id": "console",
"file": "shared/console"
},
{
"name": "generate",
"id": "generate",
Expand Down
50 changes: 50 additions & 0 deletions docs/shared/console.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# Nx Console

<figure>
<img
src="/assets/content/shared/nx-console-logo.png"
alt="Nx Console logo"
style="max-width: 100%;"
/>
</figure>

**Spend less time looking up command line arguments and more time shipping incredible products.**

- [Install from the VSCode Marketplace](https://marketplace.visualstudio.com/items?itemName=nrwl.angular-console)
- [Contribute on GitHub](https://github.com/nrwl/nx-console)

<figure>
<img
src="/assets/content/shared/nx-console-screenshot.png"
alt="Nx Console screenshot"
style="max-width: 100%;"
/>
</figure>

With Nx, you can get a full-stack application up and running in minutes, no need to figure out source maps, webpack, test runners. It all works out of the box. Nx also helps you enforce consistent development practices by generating components, services, and state management modules.

## Why Nx Console?

Developers use both command-line tools and user interfaces. They commit in the terminal, but resolve conflicts in VSCode or WebStorm. They use the right tool for the job.

Nx is a command-line tool, which works great when you want to serve an application or generate a simple component. But it falls short once you start doing advanced things.

For instance:

- Exploring custom schematic collections is hard in the terminal, but it's easy using Nx Console.
- Using rarely-used flags is challenging. Do you pass absolute or relative paths? You don't have to remember any flags, names, or paths -- Nx Console will help you by providing autocompletion and validating your inputs.
- Finding the right Nx extension can take a long time. When using Nx Console, you can find and install an extension in minutes.

Nx Console does all that and more!

## Download

For VSCode users, you can install the [Nx Console VSCode Plugin](https://marketplace.visualstudio.com/items?itemName=nrwl.angular-console) from Marketplace.

## True UI for Nx

Nx Console is the UI for Nx. It will work for any schematic or any architect commands. Nx Console does not have a specific UI for, say, generating a component. Instead, Nx Console does what the command-line version of Nx does--it analyzes the same meta information to create the needed UI. This means that anything you can do with Nx, you can do with Nx Console. After all, Nx Console is the UI for Nx.

## Useful for Both Experts and Beginners

Even though we started building Nx Console as a tool for experts, we also aimed to make Nx Console a great tool for developers who are new to development or Nx. You can create projects, interact with your editor, run generators and commands, install extensions without ever touching the terminal or having to install any node packages globally. Also, Nx Console highlights the properties you are likely to use for built-in generators and commands, so if you haven't used the CLI, you don't get overwhelmed.
Binary file added docs/shared/nx-console-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/shared/nx-console-screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 6672e56

Please sign in to comment.