[components] Move dg cli back to verb-first (update docs)

Author: smackesey

docs/docs/guides/labs/components/existing-code-location.md

@@ -11,7 +11,7 @@ This feature is still in development and might change in patch releases. It’s
 
 :::note
 
-This guide is only relevant if you are starting from an _existing_ Dagster code location. This setup is unnecessary if you used `dg code-location generate` to create your code location.
+This guide is only relevant if you are starting from an _existing_ Dagster code location. This setup is unnecessary if you used `dg scaffold code-location` to create your code location.
 
 :::
 

docs/docs/guides/labs/components/index.md

@@ -106,7 +106,7 @@ First let's set up Sling. If we query the available component types in our envir
 This is because the basic `dagster-components` package (which was installed when we scaffolded our code location) is lightweight and doesn't include components for specific integrations (like Sling). We can get access to a Sling component by installing the `sling` extra of `dagster-components`:
 
 :::note
-Recall that `dg` always operates in an isolated environment-- so how is it able to access the set of components types available in our project environment? Under the hood, `dg` attempts to resolve a project root whenever it is run. If it finds a `pyproject.toml` file with a `tool.dg.is_code_location = true` setting, then it will by default expect a `uv`-managed virtual environment to be present in the same directory (this can be confirmed by the presence of a `uv.lock` file). When you run commands like `dg component-type list`, `dg` obtains the results by identifying the in-scope project environment and querying it. In this case, the project environment was set up for us as part of the `dg code-location scaffold` command.
+Recall that `dg` always operates in an isolated environment-- so how is it able to access the set of components types available in our project environment? Under the hood, `dg` attempts to resolve a project root whenever it is run. If it finds a `pyproject.toml` file with a `tool.dg.is_code_location = true` setting, then it will by default expect a `uv`-managed virtual environment to be present in the same directory (this can be confirmed by the presence of a `uv.lock` file). When you run commands like `dg list component-type`, `dg` obtains the results by identifying the in-scope project environment and querying it. In this case, the project environment was set up for us as part of the `dg scaffold code-location` command.
 :::
 
 <CliInvocationExample contents="uv add 'dagster-components[sling]'" />
@@ -177,7 +177,7 @@ We'll need to create a Dagster DBT project component to interface with the dbt p
 <CliInvocationExample path="docs_beta_snippets/docs_beta_snippets/guides/components/index/18-dg-list-component-types.txt" />
 
 
-There it is: `dagster_components.dbt_project`. We can access detailed info about a component type using the `dg component-type info` command. Let's have a look at the `dagster_components.dbt_project` component type:
+There it is: `dagster_components.dbt_project`. We can access detailed info about a component type using the `dg info component-type` command. Let's have a look at the `dagster_components.dbt_project` component type:
 
 <CliInvocationExample path="docs_beta_snippets/docs_beta_snippets/guides/components/index/19-dg-component-type-info.txt" />
 
@@ -202,15 +202,15 @@ You can see at first glance that there appear to be two copies of the `raw_custo
 
 <CodeExample path="docs_beta_snippets/docs_beta_snippets/guides/components/index/22-project-jdbt-incorrect.yaml" language="YAML" title="jaffle-platform/jaffle_platform/components/jdbt/component.yaml" />
 
-You might notice the typo in the above file - after updating a component file, it's often useful to validate that the changes match the component's schema. You can do this by running `dg component check`:
+You might notice the typo in the above file - after updating a component file, it's often useful to validate that the changes match the component's schema. You can do this by running `dg check component`:
 
 <CliInvocationExample path="docs_beta_snippets/docs_beta_snippets/guides/components/index/23-dg-component-check-error.txt" />
 
 You can see that the error message includes the filename, line number, and a code snippet showing the exact nature of the error. Let's fix the typo:
 
 <CodeExample path="docs_beta_snippets/docs_beta_snippets/guides/components/index/24-project-jdbt.yaml" language="YAML" title="jaffle-platform/jaffle_platform/components/jdbt/component.yaml" />
 
-Finally, we can re-run `dg component check` to validate that our fix works:
+Finally, we can re-run `dg check component` to validate that our fix works:
 
 <CliInvocationExample path="docs_beta_snippets/docs_beta_snippets/guides/components/index/25-dg-component-check.txt" />
 

docs/docs/guides/labs/components/using-a-component.md

@@ -15,13 +15,13 @@ This feature is still in development and might change in patch releases. It’s
 You can view the available component types in your environment by running the following command:
 
 ```bash
-dg component-type list
+dg list component-type 
 ```
 
 This will display a list of all the component types that are available in your project. If you'd like to see more information about a specific component, you can run:
 
 ```bash
-dg component-type docs <component-name>
+dg docs component-type <component-name>
 ```
 
 This will display a webpage containing documentation for the specified component type.
@@ -31,7 +31,7 @@ This will display a webpage containing documentation for the specified component
 Once you've selected the component type that you'd like to use, you can instantiate a new component by running:
 
 ```bash
-dg component generate <component-type> <component-name>
+dg scaffold component <component-type> <component-name>
 ```
 
 This will create a new directory underneath your `components/` folder that contains a `component.yaml` file. Some components may also generate additional files as needed.
@@ -46,7 +46,7 @@ The `component.yaml` is the primary configuration file for a component. It conta
 To see a sample `component.yaml` file for your specific component, you can run:
 
 ```bash
-dg component-type docs <component-name>
+dg docs component-type <component-name>
 ```
 
 ## Component templating

examples/docs_beta_snippets/docs_beta_snippets/guides/components/deployments/1-deployment-scaffold.txt

@@ -1,4 +1,4 @@
-dg deployment scaffold my-deployment
+dg scaffold deployment my-deployment
 
 Creating a Dagster deployment at my-deployment.
 Scaffolded files for Dagster project in my-deployment.

examples/docs_beta_snippets/docs_beta_snippets/guides/components/deployments/10-code-location-list.txt

@@ -1,4 +1,4 @@
-dg code-location list
+dg list code-location
 
 code-location-1
 code-location-2

examples/docs_beta_snippets/docs_beta_snippets/guides/components/deployments/11-component-type-list.txt

@@ -1,4 +1,4 @@
-cd code_locations/code-location-2 && dg component-type list
+cd code_locations/code-location-2 && dg list component-type
 
 ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
 ┃ Component Type                                        ┃ Summary                        ┃

examples/docs_beta_snippets/docs_beta_snippets/guides/components/deployments/4-code-location-scaffold.txt

@@ -1,4 +1,4 @@
-dg code-location scaffold code-location-1
+dg scaffold code-location code-location-1
 
 Creating a Dagster code location at /.../my-deployment/code_locations/code-location-1.
 Scaffolded files for Dagster project in /.../my-deployment/code_locations/code-location-1.

examples/docs_beta_snippets/docs_beta_snippets/guides/components/deployments/7-component-type-list.txt

@@ -1,4 +1,4 @@
-cd code_locations/code-location-1 && dg component-type list
+cd code_locations/code-location-1 && dg list component-type
 
 ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
 ┃ Component Type                                        ┃ Summary                        ┃

examples/docs_beta_snippets/docs_beta_snippets/guides/components/deployments/8-component-type-list.txt

@@ -1,4 +1,4 @@
-dg component-type list
+dg list component-type
 
 Using /.../my-deployment/code_locations/code-location-1/.venv/bin/dagster-components
 ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓

examples/docs_beta_snippets/docs_beta_snippets/guides/components/deployments/9-code-location-scaffold.txt

@@ -1,4 +1,4 @@
-cd ../.. && dg code-location scaffold code-location-2
+cd ../.. && dg scaffold code-location code-location-2
 
 Creating a Dagster code location at /.../my-deployment/code_locations/code-location-2.
 Scaffolded files for Dagster project in /.../my-deployment/code_locations/code-location-2.

examples/docs_beta_snippets/docs_beta_snippets/guides/components/existing-project/8-dg-list-component-types.txt

@@ -1,4 +1,4 @@
-dg component-type list
+dg list component-type
 
 Using /.../my-existing-project/.venv/bin/dagster-components
 ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓

examples/docs_beta_snippets/docs_beta_snippets/guides/components/index/1-help.txt

@@ -34,9 +34,11 @@ Usage: dg [OPTIONS] COMMAND [ARGS]...
 │                                                              use for the cache.        │
 ╰────────────────────────────────────────────────────────────────────────────────────────╯
 ╭─ Commands ─────────────────────────────────────────────────────────────────────────────╮
-│ code-location    Commands for operating code location directories.                     │
-│ component        Commands for operating on components.                                 │
-│ component-type   Commands for operating on components types.                           │
-│ deployment       Commands for operating on deployment directories.                     │
-│ dev              Start a local deployment of your Dagster project.                     │
+│ check              Commands for checking the integrity of your Dagster code.           │
+│ configure-editor   Commands for configuring your editor.                               │
+│ dev                Start a local deployment of your Dagster project.                   │
+│ docs               Commands for generating docs from your Dagster code.                │
+│ info               Commands for operating on components types.                         │
+│ list               Commands for listing Dagster entities.                              │
+│ scaffold           Commands for scaffolding Dagster code.                              │
 ╰────────────────────────────────────────────────────────────────────────────────────────╯

examples/docs_beta_snippets/docs_beta_snippets/guides/components/index/18-dg-list-component-types.txt

@@ -1,4 +1,4 @@
-dg component-type list
+dg list component-type
 
 Using /.../jaffle-platform/.venv/bin/dagster-components
 ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓

examples/docs_beta_snippets/docs_beta_snippets/guides/components/index/19-dg-component-type-info.txt

@@ -1,4 +1,4 @@
-dg component-type info 'dbt_project@dagster_components'
+dg info component-type 'dbt_project@dagster_components'
 
 dbt_project@dagster_components
 

examples/docs_beta_snippets/docs_beta_snippets/guides/components/index/2-scaffold.txt

@@ -1,4 +1,4 @@
-dg code-location scaffold jaffle-platform
+dg scaffold code-location jaffle-platform
 
 Creating a Dagster code location at /.../jaffle-platform.
 Scaffolded files for Dagster project in /.../jaffle-platform.

examples/docs_beta_snippets/docs_beta_snippets/guides/components/index/20-dg-scaffold-jdbt.txt

@@ -1,4 +1,4 @@
-dg component scaffold dbt_project@dagster_components jdbt --project-path dbt/jdbt
+dg scaffold component dbt_project@dagster_components jdbt --project-path dbt/jdbt
 
 Creating a Dagster component instance folder at /.../jaffle-platform/jaffle_platform/components/jdbt.
 Using /.../jaffle-platform/.venv/bin/dagster-components

examples/docs_beta_snippets/docs_beta_snippets/guides/components/index/23-dg-component-check-error.txt

@@ -1,4 +1,4 @@
-dg component check
+dg check component
 
 /.../jaffle-platform/jaffle_platform/components/jdbt/component.yaml:8 -  Unable to parse YAML: while scanning a quoted scalar, found unexpected end of stream
      | 

examples/docs_beta_snippets/docs_beta_snippets/guides/components/index/25-dg-component-check.txt

@@ -1,3 +1,3 @@
-dg component check
+dg check component
 
 All components validated successfully.

examples/docs_beta_snippets/docs_beta_snippets/guides/components/index/7-dg-list-component-types.txt

@@ -1,4 +1,4 @@
-dg component-type list
+dg list component-type
 
 ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
 ┃ Component Type                                        ┃ Summary                        ┃

examples/docs_beta_snippets/docs_beta_snippets/guides/components/index/8-dg-list-component-types.txt

@@ -1,4 +1,4 @@
-dg component-type list
+dg list component-type
 
 Using /.../jaffle-platform/.venv/bin/dagster-components
 ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓

examples/docs_beta_snippets/docs_beta_snippets/guides/components/index/9-dg-scaffold-sling-replication.txt

@@ -1,4 +1,4 @@
-dg component scaffold 'sling_replication_collection@dagster_components' ingest_files
+dg scaffold component 'sling_replication_collection@dagster_components' ingest_files
 
 Creating a Dagster component instance folder at /.../jaffle-platform/jaffle_platform/components/ingest_files.
 Using /.../jaffle-platform/.venv/bin/dagster-components

examples/docs_beta_snippets/docs_beta_snippets/guides/components/migrating-definitions/3-scaffold.txt

@@ -1,4 +1,4 @@
-dg component scaffold 'definitions@dagster_components' elt-definitions
+dg scaffold component 'definitions@dagster_components' elt-definitions
 
 Using /.../my-existing-project/.venv/bin/dagster-components
 Creating a Dagster component instance folder at /.../my-existing-project/my_existing_project/components/elt-definitions.

examples/docs_beta_snippets/docs_beta_snippets/guides/components/shell-script-component/1-dg-scaffold-shell-command.txt

@@ -1,4 +1,4 @@
-dg component-type scaffold shell_command
+dg scaffold component-type shell_command
 
 Creating a Dagster component type at /.../my-component-library/my_component_library/lib/shell_command.py.
 Scaffolded files for Dagster project in /.../my-component-library/my_component_library/lib.

examples/docs_beta_snippets/docs_beta_snippets/guides/components/shell-script-component/3-dg-list-component-types.txt

@@ -1,4 +1,4 @@
-dg component-type list
+dg list component-type
 
 Using /.../my-component-library/.venv/bin/dagster-components
 ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓

examples/docs_beta_snippets/docs_beta_snippets/guides/components/shell-script-component/4-dg-component-type-docs.txt

@@ -1 +1 @@
-dg component-type docs shell_command@my_component_library
+dg docs component-type shell_command@my_component_library

examples/docs_beta_snippets/docs_beta_snippets/guides/components/shell-script-component/6-scaffold-instance-of-component.txt

@@ -1,4 +1,4 @@
-dg component scaffold 'shell_command@my_component_library' my_shell_command
+dg scaffold component 'shell_command@my_component_library' my_shell_command
 
 Using /.../my-component-library/.venv/bin/dagster-components
 Creating a Dagster component instance folder at /.../my-component-library/my_component_library/components/my_shell_command.

examples/docs_beta_snippets/docs_beta_snippets_tests/snippet_checks/guides/components/test_component_docs_existing_code_location/test_existing_code_location.py

@@ -150,7 +150,7 @@ def next_snip_no():
         )
 
         run_command_and_snippet_output(
-            cmd="dg component-type list",
+            cmd="dg list component-type",
             snippet_path=COMPONENTS_SNIPPETS_DIR
             / f"{next_snip_no()}-dg-list-component-types.txt",
             update_snippets=update_snippets,

examples/docs_beta_snippets/docs_beta_snippets_tests/snippet_checks/guides/components/test_components_docs.py

@@ -68,7 +68,7 @@ def next_snip_no():
 
         # Scaffold code location
         run_command_and_snippet_output(
-            cmd="dg code-location scaffold jaffle-platform --use-editable-dagster",
+            cmd="dg scaffold code-location jaffle-platform --use-editable-dagster",
             snippet_path=COMPONENTS_SNIPPETS_DIR / f"{next_snip_no()}-scaffold.txt",
             update_snippets=update_snippets,
             snippet_replace_regex=[
@@ -113,7 +113,7 @@ def next_snip_no():
         )
 
         run_command_and_snippet_output(
-            cmd="dg component-type list",
+            cmd="dg list component-type",
             snippet_path=COMPONENTS_SNIPPETS_DIR
             / f"{next_snip_no()}-dg-list-component-types.txt",
             update_snippets=update_snippets,
@@ -125,7 +125,7 @@ def next_snip_no():
         )
         _run_command("uv tree")
         run_command_and_snippet_output(
-            cmd="dg component-type list",
+            cmd="dg list component-type",
             snippet_path=COMPONENTS_SNIPPETS_DIR
             / f"{next_snip_no()}-dg-list-component-types.txt",
             update_snippets=update_snippets,
@@ -134,7 +134,7 @@ def next_snip_no():
 
         # Scaffold new ingestion, validate new files
         run_command_and_snippet_output(
-            cmd="dg component scaffold 'sling_replication_collection@dagster_components' ingest_files",
+            cmd="dg scaffold component 'sling_replication_collection@dagster_components' ingest_files",
             snippet_path=COMPONENTS_SNIPPETS_DIR
             / f"{next_snip_no()}-dg-scaffold-sling-replication.txt",
             update_snippets=update_snippets,
@@ -247,14 +247,14 @@ def next_snip_no():
                 f"uv add --editable '{EDITABLE_DIR / 'dagster-dbt'!s}' && uv add --editable '{EDITABLE_DIR / 'dagster-components'!s}[dbt]'; uv add dbt-duckdb"
             )
             run_command_and_snippet_output(
-                cmd="dg component-type list",
+                cmd="dg list component-type",
                 snippet_path=COMPONENTS_SNIPPETS_DIR
                 / f"{next_snip_no()}-dg-list-component-types.txt",
                 update_snippets=update_snippets,
                 snippet_replace_regex=[MASK_JAFFLE_PLATFORM],
             )
             run_command_and_snippet_output(
-                cmd="dg component-type info 'dbt_project@dagster_components'",
+                cmd="dg info component-type 'dbt_project@dagster_components'",
                 snippet_path=COMPONENTS_SNIPPETS_DIR
                 / f"{next_snip_no()}-dg-component-type-info.txt",
                 update_snippets=update_snippets,
@@ -263,7 +263,7 @@ def next_snip_no():
 
             # Scaffold dbt project components
             run_command_and_snippet_output(
-                cmd="dg component scaffold dbt_project@dagster_components jdbt --project-path dbt/jdbt",
+                cmd="dg scaffold component dbt_project@dagster_components jdbt --project-path dbt/jdbt",
                 snippet_path=COMPONENTS_SNIPPETS_DIR
                 / f"{next_snip_no()}-dg-scaffold-jdbt.txt",
                 update_snippets=update_snippets,
@@ -290,7 +290,7 @@ def next_snip_no():
 """,
             )
             run_command_and_snippet_output(
-                cmd="dg component check",
+                cmd="dg check component",
                 snippet_path=COMPONENTS_SNIPPETS_DIR
                 / f"{next_snip_no()}-dg-component-check-error.txt",
                 update_snippets=update_snippets,
@@ -314,7 +314,7 @@ def next_snip_no():
 """,
             )
             run_command_and_snippet_output(
-                cmd="dg component check",
+                cmd="dg check component",
                 snippet_path=COMPONENTS_SNIPPETS_DIR
                 / f"{next_snip_no()}-dg-component-check.txt",
                 update_snippets=update_snippets,