Skip to content

Commit f403bdf

Browse files
OwenKephartOwenKephart
committed
[dg] dg list packages
1 parent 8ff576c commit f403bdf

File tree

9 files changed

+272
-119
lines changed

9 files changed

+272
-119
lines changed

Diff for: ‎examples/docs_snippets/docs_snippets/guides/components/index/1-help.txt

+30-33
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,32 @@
11
dg --help
22

3-
Usage: dg [OPTIONS] COMMAND [ARGS]...
4-
5-
CLI for managing Dagster projects.
6-
7-
╭─ Options ──────────────────────────────────────────────────────────────────────────────╮
8-
│ --clear-cache Clear the cache. │
9-
│ --rebuild-component-registry Recompute and cache the set of available │
10-
│ component types for the current environment. │
11-
│ Note that this also happens automatically │
12-
│ whenever the cache is detected to be stale. │
13-
│ --install-completion Automatically detect your shell and install a │
14-
│ completion script for the `dg` command. This │
15-
│ will append to your shell startup file. │
16-
│ --version -v Show the version and exit. │
17-
│ --help -h Show this message and exit. │
18-
╰────────────────────────────────────────────────────────────────────────────────────────╯
19-
╭─ Global options ───────────────────────────────────────────────────────────────────────╮
20-
│ --verbose Enable verbose output for debugging. │
21-
│ --disable-cache Disable the cache.. │
22-
│ --cache-dir TEXT Specify a directory to use for the cache. │
23-
╰────────────────────────────────────────────────────────────────────────────────────────╯
24-
╭─ Commands ─────────────────────────────────────────────────────────────────────────────╮
25-
│ check Commands for checking the integrity of your Dagster code. │
26-
│ dev Start a local instance of Dagster. │
27-
│ docs Commands for generating docs from your Dagster code. │
28-
│ env Commands for managing environment variables. │
29-
│ init Initialize a new Dagster workspace and a first project within that │
30-
│ workspace. │
31-
│ launch Launch a Dagster run. │
32-
│ list Commands for listing Dagster entities. │
33-
│ scaffold Commands for scaffolding Dagster code. │
34-
│ utils Assorted utility commands. │
35-
╰────────────────────────────────────────────────────────────────────────────────────────╯
3+
Usage: dg [OPTIONS] COMMAND [ARGS]...
4+
5+
CLI for managing Dagster projects.
6+
7+
╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
8+
│ --clear-cache Clear the cache. │
9+
│ --rebuild-component-registry Recompute and cache the set of available component types for the current │
10+
│ environment. Note that this also happens automatically whenever the cache is │
11+
│ detected to be stale. │
12+
│ --install-completion Automatically detect your shell and install a completion script for the `dg` │
13+
│ command. This will append to your shell startup file. │
14+
│ --version -v Show the version and exit. │
15+
│ --help -h Show this message and exit. │
16+
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
17+
╭─ Global options ─────────────────────────────────────────────────────────────────────────────────────────────────────╮
18+
│ --verbose Enable verbose output for debugging. │
19+
│ --disable-cache Disable the cache.. │
20+
│ --cache-dir TEXT Specify a directory to use for the cache. │
21+
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
22+
╭─ Commands ───────────────────────────────────────────────────────────────────────────────────────────────────────────╮
23+
│ check Commands for checking the integrity of your Dagster code. │
24+
│ dev Start a local instance of Dagster. │
25+
│ docs Commands for generating docs from your Dagster code. │
26+
│ env Commands for managing environment variables. │
27+
│ init Initialize a new Dagster workspace and a first project within that workspace. │
28+
│ launch Launch a Dagster run. │
29+
│ list Commands for listing Dagster entities. │
30+
│ scaffold Commands for scaffolding Dagster code. │
31+
│ utils Assorted utility commands. │
32+
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯

Diff for: ‎examples/docs_snippets/docs_snippets/guides/components/index/18-dg-list-component-types.txt

+38-20
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,41 @@
11
dg list component-type
22

33
Using /.../jaffle-platform/.venv/bin/dagster-components
4-
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━┓
5-
┃ Component Type ┃ Summary ┃
6-
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━┩
7-
│ dagster.components.DefinitionsComponent │ An arbitrary set of │
8-
│ │ dagster definitions. │
9-
│ dagster.components.DefsFolderComponent │ A folder which may │
10-
│ │ contain multiple │
11-
│ │ submodules, each │
12-
│ │ which define components. │
13-
│ dagster.components.PipesSubprocessScriptCollectionComponent │ Assets that wrap Python │
14-
│ │ scripts executed with │
15-
│ │ Dagster's │
16-
│ │ PipesSubprocessClient. │
17-
│ dagster_dbt.DbtProjectComponent │ Expose a DBT project to │
18-
│ │ Dagster as a set of │
19-
│ │ assets. │
20-
│ dagster_sling.SlingReplicationCollectionComponent │ Expose one or more Sling │
21-
│ │ replications to Dagster │
22-
│ │ as assets. │
23-
└─────────────────────────────────────────────────────────────┴──────────────────────────┘
4+
┏━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
5+
┃ Package ┃ Entries ┃
6+
┡━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
7+
│ dagster │ ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━┓ │
8+
│ │ ┃ Key ┃ Summary ┃ Types ┃ │
9+
│ │ ┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━┩ │
10+
│ │ │ dagster.components.DefinitionsComponent │ An arbitrary set │ [component, │ │
11+
│ │ │ │ of dagster │ scaffold-targe… │ │
12+
│ │ │ │ definitions. │ │ │
13+
│ │ ├─────────────────────────────────────────────────────────────┼──────────────────┼─────────────────┤ │
14+
│ │ │ dagster.components.DefsFolderComponent │ A folder which │ [component, │ │
15+
│ │ │ │ may contain │ scaffold-targe… │ │
16+
│ │ │ │ multiple │ │ │
17+
│ │ │ │ submodules, each │ │ │
18+
│ │ │ │ which define │ │ │
19+
│ │ │ │ components. │ │ │
20+
│ │ ├─────────────────────────────────────────────────────────────┼──────────────────┼─────────────────┤ │
21+
│ │ │ dagster.components.PipesSubprocessScriptCollectionComponent │ Assets that wrap │ [component, │ │
22+
│ │ │ │ Python scripts │ scaffold-targe… │ │
23+
│ │ │ │ executed with │ │ │
24+
│ │ │ │ Dagster's │ │ │
25+
│ │ │ │ PipesSubprocess… │ │ │
26+
│ │ └─────────────────────────────────────────────────────────────┴──────────────────┴─────────────────┘ │
27+
│ dagster_dbt │ ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ │
28+
│ │ ┃ Key ┃ Summary ┃ Types ┃ │
29+
│ │ ┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩ │
30+
│ │ │ dagster_dbt.DbtProjectComponent │ Expose a DBT project to Dagster │ [component, scaffold-target] │ │
31+
│ │ │ │ as a set of assets. │ │ │
32+
│ │ └─────────────────────────────────┴─────────────────────────────────┴──────────────────────────────┘ │
33+
│ dagster_sling │ ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━┓ │
34+
│ │ ┃ Key ┃ Summary ┃ Types ┃ │
35+
│ │ ┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━┩ │
36+
│ │ │ dagster_sling.SlingReplicationCollectionComponent │ Expose one or more │ [component, │ │
37+
│ │ │ │ Sling replications │ scaffold-target] │ │
38+
│ │ │ │ to Dagster as │ │ │
39+
│ │ │ │ assets. │ │ │
40+
│ │ └───────────────────────────────────────────────────┴──────────────────────┴───────────────────────┘ │
41+
└───────────────┴──────────────────────────────────────────────────────────────────────────────────────────────────────┘

0 commit comments

Comments
 (0)