References

CLI

goldsky <cmd> args

How to use:

Commands:
  goldsky login     Log in to Goldsky to enable running authenticated CLI comman
                    ds
  goldsky logout    Log out of Goldsky on this computer
  goldsky subgraph  commands related to subgraphs

Options:
      --token    CLI Auth Token                           [string] [default: ""]
  -v, --version  Show version number                                   [boolean]
  -h, --help     Show help                                             [boolean]

login

goldsky login

How to use:

Log in to Goldsky to enable running authenticated CLI commands

Options:
      --token  CLI Auth Token                             [string] [default: ""]
  -h, --help   Show help                                               [boolean]

logout

goldsky logout

How to use:

Log out of Goldsky on this computer

Options:
      --token  CLI Auth Token                             [string] [default: ""]
  -h, --help   Show help                                               [boolean]

subgraph

goldsky subgraph

How to use:

commands related to subgraphs

Commands:
  goldsky subgraph deploy <nameAndVersion>  Deploy a subgraph to Goldsky
  goldsky subgraph list [nameAndVersion]    View deployed subgraphs and tags
  goldsky subgraph delete <nameAndVersion>  Delete a subgraph from Goldsky
  goldsky subgraph tag                      Commands related to tags
  goldsky subgraph webhook                  [BETA] Commands related to webhooks


Options:
      --token  CLI Auth Token                             [string] [default: ""]
  -h, --help   Show help                                               [boolean]

subgraph deploy

goldsky subgraph deploy <nameAndVersion>

How to use:

Deploy a subgraph to Goldsky

Positionals:
  nameAndVersion  Name and version of the subgraph, e.g. 'my-subgraph/1.0.0'
                                                             [string] [required]

Options:
      --token           CLI Auth Token                    [string] [default: ""]
      --path            Path to subgraph                                [string]
      --from-ipfs-hash  IPFS hash of a publicly deployed subgraph       [string]
      --ipfs-gateway    IPFS gateway to use if downloading the subgraph from IPF
                        S[string] [default: "https://ipfs.network.thegraph.com"]
      --from-url        GraphQL endpoint for a publicly deployed subgraph
                                                                        [string]
      --overwrite       Overwrite existing subgraph with the matching name/versi
                        on                            [boolean] [default: false]
  -h, --help            Show help                                      [boolean]

subgraph list

goldsky subgraph list [nameAndVersion]

How to use:

View deployed subgraphs and tags

Positionals:
  nameAndVersion  Name and version of the subgraph, e.g. 'my-subgraph/1.0.0'
                                                                        [string]

Options:
      --token    CLI Auth Token                           [string] [default: ""]
      --filter   Limit results to just tags or deployments
                                                [choices: "tags", "deployments"]
      --summary  Summarize subgraphs & versions without all their details
                                                      [boolean] [default: false]
  -h, --help     Show help                                             [boolean]

subgraph delete

goldsky subgraph delete <nameAndVersion>

How to use:

Delete a subgraph from Goldsky

Positionals:
  nameAndVersion  Name and version of the subgraph, e.g. 'my-subgraph/1.0.0'
                                                             [string] [required]

Options:
      --token  CLI Auth Token                             [string] [default: ""]
  -h, --help   Show help                                               [boolean]

subgraph tag

goldsky subgraph tag

How to use:

Commands related to tags

Commands:
  goldsky subgraph tag create <nameAndVers  Create a new tag
  ion>
  goldsky subgraph tag delete <nameAndVers  Delete a tag
  ion>

Options:
      --token  CLI Auth Token                             [string] [default: ""]
  -h, --help   Show help                                               [boolean]

subgraph tag create

goldsky subgraph tag create <nameAndVersion>

How to use:

Create a new tag

Positionals:
  nameAndVersion  Name and version of the subgraph, e.g. 'my-subgraph/1.0.0'
                                                             [string] [required]

Options:
      --token  CLI Auth Token                             [string] [default: ""]
  -t, --tag    The name of the tag                           [string] [required]
  -h, --help   Show help                                               [boolean]

subgraph tag delete

goldsky subgraph tag delete <nameAndVersion>

How to use:

Delete a tag

Positionals:
  nameAndVersion  Name and version of the subgraph, e.g. 'my-subgraph/1.0.0'
                                                             [string] [required]

Options:
      --token  CLI Auth Token                             [string] [default: ""]
  -t, --tag    The name of the tag to delete                 [string] [required]
  -h, --help   Show help                                               [boolean]

subgraph webhook

goldsky subgraph webhook

How to use:

[BETA] Commands related to webhooks

Commands:
  goldsky subgraph webhook create <nameAnd  [BETA] commands related to webhooks
  Version>
  goldsky subgraph webhook delete           [BETA] Delete a webhook
  goldsky subgraph webhook list             [BETA] List webhooks

Options:
      --token  CLI Auth Token                             [string] [default: ""]
  -h, --help   Show help                                               [boolean]

subgraph webhook create

goldsky subgraph webhook create <nameAndVersion>

How to use:

[BETA] commands related to webhooks

Positionals:
  nameAndVersion  Name and version of the subgraph, e.g. 'my-subgraph/1.0.0'
                                                             [string] [required]

Options:
      --token   CLI Auth Token                            [string] [default: ""]
      --name    Name of the webhook, must be unique          [string] [required]
      --url     URL to send events to                        [string] [required]
      --entity  Subgraph entity to send events for           [string] [required]
  -h, --help    Show help                                              [boolean]

subgraph webhook delete

goldsky subgraph webhook delete

How to use:

[BETA] Delete a webhook

Options:
      --token  CLI Auth Token                             [string] [default: ""]
      --name   Name of the webhook to delete                 [string] [required]
  -h, --help   Show help                                               [boolean]

subgraph webhook list

goldsky subgraph webhook list

How to use:

[BETA] List webhooks

Options:
      --token  CLI Auth Token                             [string] [default: ""]
  -h, --help   Show help                                               [boolean]
Previous
Elasticsearch