-
Notifications
You must be signed in to change notification settings - Fork 1.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
add cli docs #17037
Merged
add cli docs #17037
Changes from 10 commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
85d595a
init
aaazzam 59ea156
Update generate_cli_docs.py
aaazzam e16ac2f
fix wierdness
aaazzam d37940d
Potential fix for code scanning alert no. 2031: Jinja2 templating wit…
aaazzam 27f7d92
obey crazy ruff laws
aaazzam 809add2
Merge branch 'cli-docs' of https://github.com/PrefectHQ/prefect into …
aaazzam 30b84dd
Update generate_cli_docs.py
aaazzam f06bcd1
Update mint.json
aaazzam 0b8cc64
fix weird main prefect
aaazzam 4ee5807
Update mint.json
aaazzam 33716c1
Merge branch 'main' into cli-docs
aaazzam File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,179 @@ | ||
--- | ||
title: " " | ||
sidebarTitle: prefect artifact | ||
--- | ||
|
||
# `prefect artifact` | ||
|
||
|
||
|
||
```command | ||
prefect artifact [OPTIONS] COMMAND [ARGS]... | ||
``` | ||
|
||
|
||
|
||
<Info> | ||
Inspect and delete artifacts. | ||
</Info> | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
## `prefect artifact ls` | ||
|
||
|
||
|
||
```command | ||
prefect artifact ls [OPTIONS] | ||
``` | ||
|
||
|
||
|
||
<Info> | ||
List artifacts. | ||
</Info> | ||
|
||
|
||
|
||
|
||
|
||
|
||
<AccordionGroup> | ||
|
||
|
||
|
||
|
||
<Accordion title="Options" defaultOpen> | ||
|
||
<ResponseField name="--limit"> | ||
The maximum number of artifacts to return. | ||
</ResponseField> | ||
|
||
<ResponseField name="--all"> | ||
Whether or not to only return the latest version of each artifact. | ||
</ResponseField> | ||
|
||
</Accordion> | ||
|
||
</AccordionGroup> | ||
|
||
|
||
|
||
## `prefect artifact inspect` | ||
|
||
|
||
|
||
```command | ||
prefect artifact inspect [OPTIONS] KEY | ||
``` | ||
|
||
|
||
|
||
<Info> | ||
View details about an artifact. | ||
|
||
Arguments: | ||
key: the key of the artifact to inspect | ||
|
||
Examples: | ||
\$ prefect artifact inspect "my-artifact" | ||
[ | ||
{ | ||
'id': 'ba1d67be-0bd7-452e-8110-247fe5e6d8cc', | ||
'created': '2023-03-21T21:40:09.895910+00:00', | ||
'updated': '2023-03-21T21:40:09.895910+00:00', | ||
'key': 'my-artifact', | ||
'type': 'markdown', | ||
'description': None, | ||
'data': 'my markdown', | ||
'metadata_': None, | ||
'flow_run_id': '8dc54b6f-6e24-4586-a05c-e98c6490cb98', | ||
'task_run_id': None | ||
}, | ||
{ | ||
'id': '57f235b5-2576-45a5-bd93-c829c2900966', | ||
'created': '2023-03-27T23:16:15.536434+00:00', | ||
'updated': '2023-03-27T23:16:15.536434+00:00', | ||
'key': 'my-artifact', | ||
'type': 'markdown', | ||
'description': 'my-artifact-description', | ||
'data': 'my markdown', | ||
'metadata_': None, | ||
'flow_run_id': 'ffa91051-f249-48c1-ae0f-4754fcb7eb29', | ||
'task_run_id': None | ||
} | ||
] | ||
</Info> | ||
|
||
|
||
|
||
|
||
|
||
|
||
<AccordionGroup> | ||
|
||
|
||
<Accordion title="Arguments" defaultOpen> | ||
<ResponseField name="KEY" type="string" required> | ||
\[required] | ||
</ResponseField> | ||
</Accordion> | ||
|
||
|
||
|
||
<Accordion title="Options" defaultOpen> | ||
|
||
<ResponseField name="--limit"> | ||
The maximum number of artifacts to return. | ||
</ResponseField> | ||
|
||
</Accordion> | ||
|
||
</AccordionGroup> | ||
|
||
|
||
|
||
## `prefect artifact delete` | ||
|
||
|
||
|
||
```command | ||
prefect artifact delete [OPTIONS] [KEY] | ||
``` | ||
|
||
|
||
|
||
<Info> | ||
Delete an artifact. | ||
</Info> | ||
|
||
|
||
|
||
|
||
|
||
|
||
<AccordionGroup> | ||
|
||
|
||
<Accordion title="Arguments" defaultOpen> | ||
<ResponseField name="KEY" type="string"> | ||
The key of the artifact to delete. | ||
</ResponseField> | ||
</Accordion> | ||
|
||
|
||
|
||
<Accordion title="Options" defaultOpen> | ||
|
||
<ResponseField name="--id"> | ||
The ID of the artifact to delete. | ||
</ResponseField> | ||
|
||
</Accordion> | ||
|
||
</AccordionGroup> |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For consistency, we should either drop the "Reference" and "Overview" suffixes or else ensure that all top-level items use the same suffix. I think removing makes more sense.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My vote would be removing all the suffixes