Skip to content
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
merged 11 commits into from
Feb 7, 2025
Merged
Show file tree
Hide file tree
Changes from 10 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions docs/mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -724,6 +724,35 @@
}
],
"version": "v3"
},
{
"group": "CLI Reference",
Copy link
Contributor

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.

image
Suggested change
"group": "CLI Reference",
"group": "CLI",

Copy link
Contributor

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

"pages": [
"v3/api-ref/cli/artifact",
"v3/api-ref/cli/automation",
"v3/api-ref/cli/block",
"v3/api-ref/cli/concurrency-limit",
"v3/api-ref/cli/config",
"v3/api-ref/cli/dashboard",
"v3/api-ref/cli/deployment",
"v3/api-ref/cli/dev",
"v3/api-ref/cli/event",
"v3/api-ref/cli/flow-run",
"v3/api-ref/cli/flow",
"v3/api-ref/cli/global-concurrency-limit",
"v3/api-ref/cli/init",
"v3/api-ref/cli/profile",
"v3/api-ref/cli/profiles",
"v3/api-ref/cli/server",
"v3/api-ref/cli/shell",
"v3/api-ref/cli/task-run",
"v3/api-ref/cli/task",
"v3/api-ref/cli/variable",
"v3/api-ref/cli/version",
"v3/api-ref/cli/work-pool",
"v3/api-ref/cli/work-queue",
"v3/api-ref/cli/worker"
]
}
],
"version": "v3"
Expand Down
7 changes: 7 additions & 0 deletions docs/styles.css
Original file line number Diff line number Diff line change
Expand Up @@ -33,3 +33,10 @@ h1, h2, h3, h4, h5, h6 {
p {
font-family: 'Inter', sans-serif;
}

[role="listitem"] *:last-child {
border-bottom: none !important;
}



179 changes: 179 additions & 0 deletions docs/v3/api-ref/cli/artifact.mdx
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"
[
&#123;
'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
&#125;,
&#123;
'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
&#125;
]
</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>
Loading
Loading