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.

Sign up for GitHub

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

Update documentation #5741

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update documentation #5741

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
34d6f71
Update documentation
PlayAnyData Oct 23, 2024
f65dfd1
Update README.md
PlayAnyData Oct 23, 2024
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
8 changes: 4 additions & 4 deletions packages/libraries/cli/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ _See code:

## `hive artifact:fetch`

fetch artifacts from the CDN
fetch artifacts from the CDN. Note that the path shown in UI already contains `artifact`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is actually set in code, and not in README: (this file is generated)

https://gitkraken.dev/link/dnNjb2RlOi8vZWFtb2Rpby5naXRsZW5zL2xpbmsvci9kYzNiYzFlYzg3ODJmMDdiYjViYzkxMjYyMDQ2Njk1NTA5NThjZGY5L2YvcGFja2FnZXMvbGlicmFyaWVzL2NsaS9zcmMvY29tbWFuZHMvYXJ0aWZhY3QvZmV0Y2gudHM%2FdXJsPWdpdCU0MGdpdGh1Yi5jb20lM0FrYW1pbGtpc2llbGElMkZncmFwaHFsLWhpdmUuZ2l0?origin=gitlens


```
USAGE
Expand All @@ -111,16 +111,16 @@ USAGE
FLAGS
--artifact=<option> (required) artifact to fetch (Note: supergraph is only available for federation projects)
<options: sdl|supergraph|metadata|services|sdl.graphql|sdl.graphqls>
--cdn.accessToken=<value> CDN access token
--cdn.endpoint=<value> CDN endpoint
--cdn.accessToken=<value> CDN access token (alternatively set via env var `HIVE_CDN_ENDPOINT`)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same here

--cdn.endpoint=<value> CDN endpoint (alternatively set via env var `HIVE_CDN_ACCESS_TOKEN`)
--outputFile=<value> whether to write to a file instead of stdout

DESCRIPTION
fetch artifacts from the CDN
```

_See code:
[dist/commands/artifact/fetch.js](https://github.com/graphql-hive/platform/blob/v0.37.0/dist/commands/artifact/fetch.js)_
[dist/commands/artifact/fetch.js](https://github.com/graphql-hive/platform/blob/main/packages/libraries/cli/src/commands/artifact/fetch.ts)_

## `hive config:delete KEY`

Expand Down