mirror of
https://github.com/hasura/graphql-engine.git
synced 2024-09-20 23:17:30 +03:00
docs: update cli long punctuation and update commands
PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7504 GitOrigin-RevId: dec1f870b9049ccc5cb793e960fb4040d18a3834
This commit is contained in:
parent
5595e85e27
commit
9bde77ab36
@ -309,7 +309,7 @@ func genMarkdownXCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string
|
||||
buf.WriteString(fmt.Sprintf("%s\n\n", long))
|
||||
buf.WriteString("```\n\n")
|
||||
} else {
|
||||
buf.WriteString(fmt.Sprintf("%s\n\n", long+"."))
|
||||
buf.WriteString(fmt.Sprintf("%s\n\n", long))
|
||||
}
|
||||
|
||||
if cmd.Runnable() {
|
||||
|
@ -40,7 +40,7 @@ func NewPluginsCmd(ec *cli.ExecutionContext) *cobra.Command {
|
||||
Use: "plugins",
|
||||
Aliases: []string{"plugin"},
|
||||
Short: "Manage plugins for the CLI",
|
||||
Long: "The functionality of the CLI can be extended by using plugins. For a list of all available plugins, run 'hasura plugins list', or visit this repository: https://github.com/hasura/cli-plugins-index.\n\nIf you're interested in contributing, please open a PR against this repo to add new plugin.`",
|
||||
Long: "The functionality of the CLI can be extended by using plugins. For a list of all available plugins, run ``hasura plugins list``, or visit this repository: https://github.com/hasura/cli-plugins-index.\n\nIf you're interested in contributing, please open a PR against this repo to add new plugin.",
|
||||
SilenceUsage: true,
|
||||
PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
|
||||
op := genOpName(cmd, "PersistentPreRunE")
|
||||
|
@ -19,7 +19,7 @@ func newUpdateMultipleSources(ec *cli.ExecutionContext) *cobra.Command {
|
||||
cmd := &cobra.Command{
|
||||
Use: "update-project-v3",
|
||||
Short: "Update the Hasura Project from config v2 to v3",
|
||||
Long: "This helper script upgrades your CLI project to use config v3. This process is completely independent from your Hasura Graphql Engine server update process",
|
||||
Long: "This helper script upgrades your CLI project to use config v3. This process is completely independent from your Hasura Graphql Engine server update process.",
|
||||
SilenceUsage: true,
|
||||
PreRunE: func(cmd *cobra.Command, args []string) error {
|
||||
op := genOpName(cmd, "PreRunE")
|
||||
|
@ -44,12 +44,12 @@ hasura [flags]
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
- [hasura actions](/hasura-cli/commands/hasura_actions.mdx) - Manage Hasura actions
|
||||
- [hasura completion](/hasura-cli/commands/hasura_completion.mdx) - Generate auto completion code
|
||||
- [hasura console](/hasura-cli/commands/hasura_console.mdx) - Open the console to manage the database and try out APIs
|
||||
- [hasura deploy](/hasura-cli/commands/hasura_deploy.mdx) - (PREVIEW) Utility command to apply metadata & database migrations to graphql-engine
|
||||
- [hasura init](/hasura-cli/commands/hasura_init.mdx) - Initialize a directory for Hasura GraphQL Engine migrations
|
||||
- [hasura metadata](/hasura-cli/commands/hasura_metadata.mdx) - Manage Hasura GraphQL Engine metadata saved in the database
|
||||
- [hasura actions](/hasura-cli/commands/hasura_actions.mdx) - Manage Hasura Actions
|
||||
- [hasura completion](/hasura-cli/commands/hasura_completion.mdx) - Generate auto-completion code
|
||||
- [hasura console](/hasura-cli/commands/hasura_console.mdx) - Open the Console to manage the database and try out APIs
|
||||
- [hasura deploy](/hasura-cli/commands/hasura_deploy.mdx) - (PREVIEW) Utility command to apply Hasura Metadata & database migrations to graphql-engine
|
||||
- [hasura init](/hasura-cli/commands/hasura_init.mdx) - Initialize a new Hasura GraphQL Engine project
|
||||
- [hasura metadata](/hasura-cli/commands/hasura_metadata.mdx) - Manage Hasura GraphQL Engine Metadata saved in the database
|
||||
- [hasura migrate](/hasura-cli/commands/hasura_migrate.mdx) - Manage migrations on the database
|
||||
- [hasura plugins](/hasura-cli/commands/hasura_plugins.mdx) - Manage plugins for the CLI
|
||||
- [hasura scripts](/hasura-cli/commands/hasura_scripts.mdx) - Execute helper scripts to manage Hasura Projects
|
||||
|
@ -11,11 +11,17 @@ keywords:
|
||||
|
||||
# Hasura CLI: hasura actions
|
||||
|
||||
Manage Hasura actions.
|
||||
Manage Hasura Actions.
|
||||
|
||||
## Synopsis
|
||||
|
||||
Manage Hasura actions.
|
||||
Running this command enables the use of additional sub-commands to create, modify, and export code related to a project's Actions.
|
||||
|
||||
Further Reading:
|
||||
- https://hasura.io/docs/latest/actions/index/
|
||||
- https://hasura.io/docs/latest/actions/create/
|
||||
- https://hasura.io/docs/latest/actions/derive/
|
||||
|
||||
|
||||
## Options
|
||||
|
||||
@ -40,8 +46,8 @@ Manage Hasura actions.
|
||||
## SEE ALSO
|
||||
|
||||
- [hasura](/hasura-cli/commands/hasura.mdx) - Hasura GraphQL Engine command line tool
|
||||
- [hasura actions codegen](/hasura-cli/commands/hasura_actions_codegen.mdx) - Generate code for actions
|
||||
- [hasura actions create](/hasura-cli/commands/hasura_actions_create.mdx) - Create a Hasura action
|
||||
- [hasura actions use-codegen](/hasura-cli/commands/hasura_actions_use-codegen.mdx) - Use the codegen to generate code for Hasura actions
|
||||
- [hasura actions codegen](/hasura-cli/commands/hasura_actions_codegen.mdx) - Generate code for Actions
|
||||
- [hasura actions create](/hasura-cli/commands/hasura_actions_create.mdx) - Create a Hasura Action
|
||||
- [hasura actions use-codegen](/hasura-cli/commands/hasura_actions_use-codegen.mdx) - Use the codegen to generate code for Hasura Actions
|
||||
|
||||
_Auto generated by spf13/cobra_
|
||||
|
@ -11,11 +11,15 @@ keywords:
|
||||
|
||||
# Hasura CLI: hasura actions codegen
|
||||
|
||||
Generate code for actions.
|
||||
Generate code for Actions.
|
||||
|
||||
## Synopsis
|
||||
|
||||
Generate code for actions.
|
||||
Running this command will generate code for either specified or all Actions. The CLI allows you to select a framework and language for generating code. Further, you also have the option of cloning a starter kit of your chosen framework and choosing the output directory for the generated code.
|
||||
|
||||
Further Reading:
|
||||
- https://hasura.io/docs/latest/actions/codegen/index/
|
||||
|
||||
|
||||
```bash
|
||||
hasura actions codegen [action-name] [flags]
|
||||
@ -24,23 +28,23 @@ hasura actions codegen [action-name] [flags]
|
||||
## Examples
|
||||
|
||||
```bash
|
||||
# Generate code for all actions
|
||||
# Generate code for all Actions
|
||||
hasura actions codegen
|
||||
|
||||
# Generate code for an action
|
||||
# Generate code for an Action
|
||||
hasura actions codegen [action-name]
|
||||
|
||||
# Generate code for two or more actions
|
||||
# Generate code for two or more Actions
|
||||
hasura actions codegen [action-name] [action-name...]
|
||||
|
||||
# Derive an action from a hasura operation
|
||||
# Derive an Action from a Hasura operation
|
||||
hasura actions codegen [action-name] --derive-from ""
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```sass
|
||||
--derive-from string derive action from a hasura operation
|
||||
--derive-from string derive Action from a Hasura operation
|
||||
-h, --help help for codegen
|
||||
```
|
||||
|
||||
@ -60,6 +64,6 @@ hasura actions codegen [action-name] --derive-from ""
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
- [hasura actions](/hasura-cli/commands/hasura_actions.mdx) - Manage Hasura actions
|
||||
- [hasura actions](/hasura-cli/commands/hasura_actions.mdx) - Manage Hasura Actions
|
||||
|
||||
_Auto generated by spf13/cobra_
|
||||
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
sidebar_label: hasura actions create
|
||||
sidebar_position: 4
|
||||
description: Create a Hasura action using the Hasura CLI
|
||||
description: Create a Hasura Action using the Hasura CLI
|
||||
keywords:
|
||||
- hasura
|
||||
- docs
|
||||
@ -11,11 +11,15 @@ keywords:
|
||||
|
||||
# Hasura CLI: hasura actions create
|
||||
|
||||
Create a Hasura action.
|
||||
Create a Hasura Action.
|
||||
|
||||
## Synopsis
|
||||
|
||||
Create a Hasura action.
|
||||
This command allows you to create an Action to extend Hasura's schema with custom business logic using queries and mutations. Optional flags can be used to derive the Action from an existing GraphQL query or mutation. Additionally, codegen can be bundled with the creation of the Action to provide you ready-to-use boilerplate with your framework of choice.
|
||||
|
||||
Further Reading:
|
||||
- https://hasura.io/docs/latest/actions/create/
|
||||
|
||||
|
||||
```bash
|
||||
hasura actions create [action-name] [flags]
|
||||
@ -24,16 +28,16 @@ hasura actions create [action-name] [flags]
|
||||
## Examples
|
||||
|
||||
```bash
|
||||
# Create a Hasura action
|
||||
# Create a Hasura Action
|
||||
hasura actions create [action-name]
|
||||
|
||||
# Create a Hasura action with codegen
|
||||
# Create a Hasura Action with codegen
|
||||
hasura actions create [action-name] --with-codegen
|
||||
|
||||
# Create a Hasura action by deriving from a hasura operation
|
||||
# Create a Hasura Action by deriving from a Hasura operation
|
||||
hasura actions create [action-name] --derive-from ''
|
||||
|
||||
# Create a Hasura action with a different kind or webhook
|
||||
# Create a Hasura Action with a different kind or webhook
|
||||
hasura actions create [action-name] --kind [synchronous|asynchronous] --webhook [http://localhost:3000]
|
||||
```
|
||||
|
||||
@ -42,9 +46,9 @@ hasura actions create [action-name] --kind [synchronous|asynchronous] --webhook
|
||||
```sass
|
||||
--derive-from string derive action from a Hasura operation
|
||||
-h, --help help for create
|
||||
--kind string kind to use in action (env "HASURA_GRAPHQL_ACTIONS_KIND")
|
||||
--webhook string webhook to use in action (env "HASURA_GRAPHQL_ACTIONS_HANDLER_WEBHOOK_BASEURL")
|
||||
--with-codegen create action along with codegen
|
||||
--kind string kind to use in Action (env "HASURA_GRAPHQL_ACTIONS_KIND")
|
||||
--webhook string webhook to use in Action (env "HASURA_GRAPHQL_ACTIONS_HANDLER_WEBHOOK_BASEURL")
|
||||
--with-codegen create Action along with codegen
|
||||
```
|
||||
|
||||
## Options inherited from parent commands
|
||||
@ -63,6 +67,6 @@ hasura actions create [action-name] --kind [synchronous|asynchronous] --webhook
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
- [hasura actions](/hasura-cli/commands/hasura_actions.mdx) - Manage Hasura actions
|
||||
- [hasura actions](/hasura-cli/commands/hasura_actions.mdx) - Manage Hasura Actions
|
||||
|
||||
_Auto generated by spf13/cobra_
|
||||
|
@ -11,11 +11,15 @@ keywords:
|
||||
|
||||
# Hasura CLI: hasura actions use-codegen
|
||||
|
||||
Use the codegen to generate code for Hasura actions.
|
||||
Use the codegen to generate code for Hasura Actions.
|
||||
|
||||
## Synopsis
|
||||
|
||||
Use the codegen to generate code for Hasura actions.
|
||||
This command generates code for Hasura Actions using the codegen framework of your choice. While not required, you can pass the ``--framework`` flag to select a framework. If you do not pass the ``--framework`` flag, you will be prompted to select a framework from a list of available options.
|
||||
|
||||
Further Reading:
|
||||
- https://hasura.io/docs/latest/actions/codegen/index/#codegen-for-your-framework
|
||||
|
||||
|
||||
```bash
|
||||
hasura actions use-codegen [flags]
|
||||
@ -62,6 +66,6 @@ hasura actions use-codegen --with-starter-kit true
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
- [hasura actions](/hasura-cli/commands/hasura_actions.mdx) - Manage Hasura actions
|
||||
- [hasura actions](/hasura-cli/commands/hasura_actions.mdx) - Manage Hasura Actions
|
||||
|
||||
_Auto generated by spf13/cobra_
|
||||
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
sidebar_label: hasura completion
|
||||
sidebar_position: 6
|
||||
description: Generate auto completion code using the Hasura CLI
|
||||
description: Generate auto-completion code using the Hasura CLI
|
||||
keywords:
|
||||
- hasura
|
||||
- docs
|
||||
@ -11,11 +11,11 @@ keywords:
|
||||
|
||||
# Hasura CLI: hasura completion
|
||||
|
||||
Generate auto completion code.
|
||||
Generate auto-completion code.
|
||||
|
||||
## Synopsis
|
||||
|
||||
Output shell completion code for the specified shell (bash or zsh).
|
||||
Depending on your shell (bash or zsh), running `hasura completion [shell]` will generate the auto-completion code for the Hasura CLI. You can then add this to your shell config to enable auto-completion, which will allow you to tab through the available commands and options.
|
||||
|
||||
```bash
|
||||
hasura completion [shell] [flags]
|
||||
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
sidebar_label: hasura console
|
||||
sidebar_position: 7
|
||||
description: Open the console to manage the database and try out APIs using the Hasura CLI
|
||||
description: Open the Console to manage the database and try out APIs using the Hasura CLI
|
||||
keywords:
|
||||
- hasura
|
||||
- docs
|
||||
@ -11,11 +11,11 @@ keywords:
|
||||
|
||||
# Hasura CLI: hasura console
|
||||
|
||||
Open the console to manage the database and try out APIs.
|
||||
Open the Console to manage the database and try out APIs.
|
||||
|
||||
## Synopsis
|
||||
|
||||
Run a web server to serve the Hasura Console for the GraphQL Engine to manage the database and build queries.
|
||||
This command will start a web server to serve the Hasura Console for the GraphQL Engine. You can use this to manage the database, build queries, and try out APIs. The Console is served at http://localhost:9695 by default. You can change the port using the --console-port flag and further configure the command by including other available flags.
|
||||
|
||||
```bash
|
||||
hasura console [flags]
|
||||
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
sidebar_label: hasura deploy
|
||||
sidebar_position: 8
|
||||
description: (PREVIEW) Utility command to apply metadata & database migrations to graphql-engine using the Hasura CLI
|
||||
description: (PREVIEW) Utility command to apply Hasura Metadata & database migrations to graphql-engine using the Hasura CLI
|
||||
keywords:
|
||||
- hasura
|
||||
- docs
|
||||
@ -11,11 +11,17 @@ keywords:
|
||||
|
||||
# Hasura CLI: hasura deploy
|
||||
|
||||
(PREVIEW) Utility command to apply metadata & database migrations to graphql-engine.
|
||||
(PREVIEW) Utility command to apply Hasura Metadata & database migrations to graphql-engine.
|
||||
|
||||
## Synopsis
|
||||
|
||||
(PREVIEW) Utility command to apply metadata & database migrations to graphql-engine.
|
||||
When working with a Hasura instance, you'll apply Hasura Metadata and database migrations to the graphql-engine server. This command reduces the number of steps by completing the same tasks ( ``hasura metadata apply`` and ``hasura migrate apply``) in one command.
|
||||
|
||||
Further reading:
|
||||
- https://hasura.io/docs/latest/migrations-metadata-seeds/index/#migrations-in-graphql-engine
|
||||
- https://hasura.io/docs/latest/migrations-metadata-seeds/manage-migrations/
|
||||
- https://hasura.io/docs/latest/migrations-metadata-seeds/manage-metadata/
|
||||
|
||||
|
||||
```bash
|
||||
hasura deploy [flags]
|
||||
@ -28,6 +34,9 @@ hasura deploy [flags]
|
||||
# Apply metadata and migrations on Hasura GraphQL Engine
|
||||
hasura deploy
|
||||
|
||||
# Apply metadata, migrations and seeds on Hasura GraphQL Engine
|
||||
hasura deploy --with-seeds
|
||||
|
||||
# Use with admin secret:
|
||||
hasura deploy --admin-secret "<admin-secret>"
|
||||
|
||||
@ -44,6 +53,7 @@ hasura deploy --endpoint "<endpoint>"
|
||||
--endpoint string http(s) endpoint for Hasura GraphQL Engine (env "HASURA_GRAPHQL_ENDPOINT")
|
||||
-h, --help help for deploy
|
||||
--insecure-skip-tls-verify skip TLS verification and disable cert checking (default: false) (env "HASURA_GRAPHQL_INSECURE_SKIP_TLS_VERIFY")
|
||||
--with-seeds apply available seeds data to databases
|
||||
```
|
||||
|
||||
## Options inherited from parent commands
|
||||
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
sidebar_label: hasura init
|
||||
sidebar_position: 11
|
||||
description: Initialize a directory for Hasura GraphQL Engine migrations using the Hasura CLI
|
||||
description: Initialize a new Hasura GraphQL Engine project using the Hasura CLI
|
||||
keywords:
|
||||
- hasura
|
||||
- docs
|
||||
@ -11,11 +11,15 @@ keywords:
|
||||
|
||||
# Hasura CLI: hasura init
|
||||
|
||||
Initialize a directory for Hasura GraphQL Engine migrations.
|
||||
Initialize a new Hasura GraphQL Engine project.
|
||||
|
||||
## Synopsis
|
||||
|
||||
Create directories and files required for enabling migrations on the Hasura GraphQL Engine.
|
||||
This is generally the first command that you would run in a new project. It creates a directory with the necessary files and directories to configure an instance of the Hasura GraphQL Engine. You can pass various flags to customize the behavior of the command and pre-configure environment variables.
|
||||
|
||||
Further reading:
|
||||
- https://hasura.io/docs/latest/migrations-metadata-seeds/migrations-metadata-setup/
|
||||
|
||||
|
||||
```bash
|
||||
hasura init [directory-name] [flags]
|
||||
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
sidebar_label: hasura metadata
|
||||
sidebar_position: 12
|
||||
description: Manage Hasura GraphQL Engine metadata saved in the database using the Hasura CLI
|
||||
description: Manage Hasura GraphQL Engine Metadata saved in the database using the Hasura CLI
|
||||
keywords:
|
||||
- hasura
|
||||
- docs
|
||||
@ -11,11 +11,15 @@ keywords:
|
||||
|
||||
# Hasura CLI: hasura metadata
|
||||
|
||||
Manage Hasura GraphQL Engine metadata saved in the database.
|
||||
Manage Hasura GraphQL Engine Metadata saved in the database.
|
||||
|
||||
## Synopsis
|
||||
|
||||
Manage Hasura GraphQL Engine metadata saved in the database.
|
||||
This command allows you to manage the Hasura GraphQL Engine Metadata saved in the database via a collection of flags and subcommands.
|
||||
|
||||
Further reading:
|
||||
- https://hasura.io/docs/latest/migrations-metadata-seeds/index/
|
||||
|
||||
|
||||
**Alias:** md
|
||||
|
||||
@ -42,11 +46,11 @@ Manage Hasura GraphQL Engine metadata saved in the database.
|
||||
## SEE ALSO
|
||||
|
||||
- [hasura](/hasura-cli/commands/hasura.mdx) - Hasura GraphQL Engine command line tool
|
||||
- [hasura metadata apply](/hasura-cli/commands/hasura_metadata_apply.mdx) - Apply Hasura metadata on a database
|
||||
- [hasura metadata clear](/hasura-cli/commands/hasura_metadata_clear.mdx) - Clear Hasura GraphQL Engine metadata on the database
|
||||
- [hasura metadata diff](/hasura-cli/commands/hasura_metadata_diff.mdx) - (PREVIEW) Show a highlighted diff of Hasura metadata
|
||||
- [hasura metadata export](/hasura-cli/commands/hasura_metadata_export.mdx) - Export Hasura GraphQL Engine metadata from the database
|
||||
- [hasura metadata inconsistency](/hasura-cli/commands/hasura_metadata_inconsistency.mdx) - Manage inconsistent objects in Hasura metadata
|
||||
- [hasura metadata reload](/hasura-cli/commands/hasura_metadata_reload.mdx) - Reload Hasura GraphQL Engine metadata on the database
|
||||
- [hasura metadata apply](/hasura-cli/commands/hasura_metadata_apply.mdx) - Apply Hasura Metadata on a database
|
||||
- [hasura metadata clear](/hasura-cli/commands/hasura_metadata_clear.mdx) - Clear Hasura GraphQL Engine Metadata on the database
|
||||
- [hasura metadata diff](/hasura-cli/commands/hasura_metadata_diff.mdx) - (PREVIEW) Show a highlighted diff of the Hasura Metadata
|
||||
- [hasura metadata export](/hasura-cli/commands/hasura_metadata_export.mdx) - Export Hasura GraphQL Engine Metadata from the database
|
||||
- [hasura metadata inconsistency](/hasura-cli/commands/hasura_metadata_inconsistency.mdx) - Manage inconsistent objects in the Hasura Metadata
|
||||
- [hasura metadata reload](/hasura-cli/commands/hasura_metadata_reload.mdx) - Reload Hasura GraphQL Engine Metadata on the database
|
||||
|
||||
_Auto generated by spf13/cobra_
|
||||
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
sidebar_label: hasura metadata apply
|
||||
sidebar_position: 13
|
||||
description: Apply Hasura metadata on a database using the Hasura CLI
|
||||
description: Apply Hasura Metadata on a database using the Hasura CLI
|
||||
keywords:
|
||||
- hasura
|
||||
- docs
|
||||
@ -11,11 +11,16 @@ keywords:
|
||||
|
||||
# Hasura CLI: hasura metadata apply
|
||||
|
||||
Apply Hasura metadata on a database.
|
||||
Apply Hasura Metadata on a database.
|
||||
|
||||
## Synopsis
|
||||
|
||||
Apply Hasura metadata on a database.
|
||||
This command applies the Hasura GraphQL Engine Metadata saved in the database. You can use it to apply Hasura Metadata from one HGE server instance to another, such as when moving between development environments.
|
||||
|
||||
Further reading:
|
||||
- https://hasura.io/docs/latest/migrations-metadata-seeds/manage-metadata/
|
||||
- https://hasura.io/docs/latest/migrations-metadata-seeds/metadata-format/
|
||||
|
||||
|
||||
```bash
|
||||
hasura metadata apply [flags]
|
||||
@ -62,6 +67,6 @@ hasura metadata apply --disallow-inconsistent-metadata
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
- [hasura metadata](/hasura-cli/commands/hasura_metadata.mdx) - Manage Hasura GraphQL Engine metadata saved in the database
|
||||
- [hasura metadata](/hasura-cli/commands/hasura_metadata.mdx) - Manage Hasura GraphQL Engine Metadata saved in the database
|
||||
|
||||
_Auto generated by spf13/cobra_
|
||||
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
sidebar_label: hasura metadata clear
|
||||
sidebar_position: 14
|
||||
description: Clear Hasura GraphQL Engine metadata on the database using the Hasura CLI
|
||||
description: Clear Hasura GraphQL Engine Metadata on the database using the Hasura CLI
|
||||
keywords:
|
||||
- hasura
|
||||
- docs
|
||||
@ -11,11 +11,11 @@ keywords:
|
||||
|
||||
# Hasura CLI: hasura metadata clear
|
||||
|
||||
Clear Hasura GraphQL Engine metadata on the database.
|
||||
Clear Hasura GraphQL Engine Metadata on the database.
|
||||
|
||||
## Synopsis
|
||||
|
||||
Clear Hasura GraphQL Engine metadata on the database.
|
||||
This command allows you to clear the Hasura GraphQL Engine Metadata. Passing in the `--endpoint` flag will clear the Hasura Metadata on the HGE instance specified by the endpoint.
|
||||
|
||||
```bash
|
||||
hasura metadata clear [flags]
|
||||
@ -58,6 +58,6 @@ hasura metadata clear --endpoint "<endpoint>"
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
- [hasura metadata](/hasura-cli/commands/hasura_metadata.mdx) - Manage Hasura GraphQL Engine metadata saved in the database
|
||||
- [hasura metadata](/hasura-cli/commands/hasura_metadata.mdx) - Manage Hasura GraphQL Engine Metadata saved in the database
|
||||
|
||||
_Auto generated by spf13/cobra_
|
||||
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
sidebar_label: hasura metadata diff
|
||||
sidebar_position: 15
|
||||
description: (PREVIEW) Show a highlighted diff of Hasura Metadata using the Hasura CLI
|
||||
description: (PREVIEW) Show a highlighted diff of the Hasura Metadata using the Hasura CLI
|
||||
keywords:
|
||||
- hasura
|
||||
- docs
|
||||
@ -11,12 +11,11 @@ keywords:
|
||||
|
||||
# Hasura CLI: hasura metadata diff
|
||||
|
||||
(PREVIEW) Show a highlighted diff of Hasura metadata.
|
||||
(PREVIEW) Show a highlighted diff of the Hasura Metadata.
|
||||
|
||||
## Synopsis
|
||||
|
||||
(PREVIEW) Show changes between two different sets of Hasura metadata.
|
||||
By default, it shows changes between the exported metadata file and server metadata.
|
||||
(PREVIEW) This command shows changes between two different sets of Hasura Metadata. By default, it shows changes between the exported Hasura Metadata and the Hasura Metadata on the server.
|
||||
|
||||
```bash
|
||||
hasura metadata diff [file1] [file2] [flags]
|
||||
@ -64,6 +63,6 @@ hasura metadata diff --endpoint "<endpoint>"
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
- [hasura metadata](/hasura-cli/commands/hasura_metadata.mdx) - Manage Hasura GraphQL Engine metadata saved in the database
|
||||
- [hasura metadata](/hasura-cli/commands/hasura_metadata.mdx) - Manage Hasura GraphQL Engine Metadata saved in the database
|
||||
|
||||
_Auto generated by spf13/cobra_
|
||||
|
@ -11,16 +11,21 @@ keywords:
|
||||
|
||||
# Hasura CLI: hasura metadata export
|
||||
|
||||
Export Hasura GraphQL Engine metadata from the database.
|
||||
Export Hasura GraphQL Engine Metadata from the database.
|
||||
|
||||
## Synopsis
|
||||
|
||||
Export Hasura Metadata and save it in the `/metadata` directory.
|
||||
The output is a bunch of yaml files which captures all the metadata required
|
||||
Export Hasura Metadata and save it in the ``/metadata`` directory.
|
||||
The output is a collection of yaml files which captures all the Metadata required
|
||||
by the GraphQL Engine. This includes info about tables that are tracked,
|
||||
permission rules, relationships and Event Triggers that are defined
|
||||
permission rules, relationships, and event triggers that are defined
|
||||
on those tables.
|
||||
|
||||
Further reading:
|
||||
- https://hasura.io/docs/latest/migrations-metadata-seeds/manage-metadata/
|
||||
- https://hasura.io/docs/latest/migrations-metadata-seeds/metadata-format/
|
||||
|
||||
|
||||
```bash
|
||||
hasura metadata export [flags]
|
||||
```
|
||||
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
sidebar_label: hasura metadata inconsistency
|
||||
sidebar_position: 17
|
||||
description: Manage inconsistent objects in Hasura metadata using the Hasura CLI
|
||||
description: Manage inconsistent objects in the Hasura Metadata using the Hasura CLI
|
||||
keywords:
|
||||
- hasura
|
||||
- docs
|
||||
@ -11,11 +11,13 @@ keywords:
|
||||
|
||||
# Hasura CLI: hasura metadata inconsistency
|
||||
|
||||
Manage inconsistent objects in Hasura metadata.
|
||||
Manage inconsistent objects in the Hasura Metadata.
|
||||
|
||||
## Synopsis
|
||||
|
||||
Manage inconsistent objects in Hasura metadata.
|
||||
This command, when used with subcommands, can be used to manage inconsistent objects in Hasura metadata. Options include:
|
||||
|
||||
`hasura metadata inconsistency list`, `hasura metadata inconsistency delete`, `hasura metadata inconsistency status`
|
||||
|
||||
**Alias:** inconsistencies, ic
|
||||
|
||||
@ -41,9 +43,9 @@ Manage inconsistent objects in Hasura metadata.
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
- [hasura metadata](/hasura-cli/commands/hasura_metadata.mdx) - Manage Hasura GraphQL Engine metadata saved in the database
|
||||
- [hasura metadata inconsistency drop](/hasura-cli/commands/hasura_metadata_inconsistency_drop.mdx) - Drop inconsistent objects from the metadata
|
||||
- [hasura metadata inconsistency list](/hasura-cli/commands/hasura_metadata_inconsistency_list.mdx) - List all inconsistent objects from the metadata
|
||||
- [hasura metadata inconsistency status](/hasura-cli/commands/hasura_metadata_inconsistency_status.mdx) - Check if the metadata is inconsistent or not
|
||||
- [hasura metadata](/hasura-cli/commands/hasura_metadata.mdx) - Manage Hasura GraphQL Engine Metadata saved in the database
|
||||
- [hasura metadata inconsistency drop](/hasura-cli/commands/hasura_metadata_inconsistency_drop.mdx) - Drop inconsistent objects from the Hasura Metadata
|
||||
- [hasura metadata inconsistency list](/hasura-cli/commands/hasura_metadata_inconsistency_list.mdx) - List all inconsistent objects from the Hasura Metadata
|
||||
- [hasura metadata inconsistency status](/hasura-cli/commands/hasura_metadata_inconsistency_status.mdx) - Check if the Hasura Metadata is inconsistent or not
|
||||
|
||||
_Auto generated by spf13/cobra_
|
||||
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
sidebar_label: hasura metadata inconsistency drop
|
||||
sidebar_position: 18
|
||||
description: Drop inconsistent objects from the metadata using the Hasura CLI
|
||||
description: Drop inconsistent objects from the Hasura Metadata using the Hasura CLI
|
||||
keywords:
|
||||
- hasura
|
||||
- docs
|
||||
@ -11,11 +11,15 @@ keywords:
|
||||
|
||||
# Hasura CLI: hasura metadata inconsistency drop
|
||||
|
||||
Drop inconsistent objects from the metadata.
|
||||
Drop inconsistent objects from the Hasura Metadata.
|
||||
|
||||
## Synopsis
|
||||
|
||||
Drop inconsistent objects from the metadata.
|
||||
At times, when developing, the Hasura Metadata can become inconsistent. This command can be used to drop inconsistent objects from the Hasura Metadata and bring your project's Metadata back to a consistent state.
|
||||
|
||||
Further reading:
|
||||
- https://hasura.io/docs/latest/migrations-metadata-seeds/resetting-migrations-metadata/
|
||||
|
||||
|
||||
```bash
|
||||
hasura metadata inconsistency drop [flags]
|
||||
@ -43,6 +47,6 @@ hasura metadata inconsistency drop [flags]
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
- [hasura metadata inconsistency](/hasura-cli/commands/hasura_metadata_inconsistency.mdx) - Manage inconsistent objects in Hasura metadata
|
||||
- [hasura metadata inconsistency](/hasura-cli/commands/hasura_metadata_inconsistency.mdx) - Manage inconsistent objects in the Hasura Metadata
|
||||
|
||||
_Auto generated by spf13/cobra_
|
||||
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
sidebar_label: hasura metadata inconsistency list
|
||||
sidebar_position: 19
|
||||
description: List all inconsistent objects from the metadata using the Hasura CLI
|
||||
description: List all inconsistent objects from the Hasura Metadata using the Hasura CLI
|
||||
keywords:
|
||||
- hasura
|
||||
- docs
|
||||
@ -11,11 +11,11 @@ keywords:
|
||||
|
||||
# Hasura CLI: hasura metadata inconsistency list
|
||||
|
||||
List all inconsistent objects from the metadata.
|
||||
List all inconsistent objects from the Hasura Metadata.
|
||||
|
||||
## Synopsis
|
||||
|
||||
List all inconsistent objects from the metadata.
|
||||
At times, when developing, the Hasura Metadata can become inconsistent. This command can be used to list all inconsistent objects from the Hasura Metadata and allow you to understand why your project's Metadata is in an inconsistent state.
|
||||
|
||||
```bash
|
||||
hasura metadata inconsistency list [flags]
|
||||
@ -46,6 +46,6 @@ hasura metadata inconsistency list [flags]
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
- [hasura metadata inconsistency](/hasura-cli/commands/hasura_metadata_inconsistency.mdx) - Manage inconsistent objects in Hasura metadata
|
||||
- [hasura metadata inconsistency](/hasura-cli/commands/hasura_metadata_inconsistency.mdx) - Manage inconsistent objects in the Hasura Metadata
|
||||
|
||||
_Auto generated by spf13/cobra_
|
||||
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
sidebar_label: hasura metadata inconsistency status
|
||||
sidebar_position: 20
|
||||
description: Check if the metadata is inconsistent or not using the Hasura CLI
|
||||
description: Check if the Hasura Metadata is inconsistent or not using the Hasura CLI
|
||||
keywords:
|
||||
- hasura
|
||||
- docs
|
||||
@ -11,11 +11,11 @@ keywords:
|
||||
|
||||
# Hasura CLI: hasura metadata inconsistency status
|
||||
|
||||
Check if the metadata is inconsistent or not.
|
||||
Check if the Hasura Metadata is inconsistent or not.
|
||||
|
||||
## Synopsis
|
||||
|
||||
Check if the metadata is inconsistent or not.
|
||||
At times, when developing, the Hasura Metadata can become inconsistent. This command can be used to check if the Metadata is inconsistent or not.
|
||||
|
||||
```bash
|
||||
hasura metadata inconsistency status [flags]
|
||||
@ -43,6 +43,6 @@ hasura metadata inconsistency status [flags]
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
- [hasura metadata inconsistency](/hasura-cli/commands/hasura_metadata_inconsistency.mdx) - Manage inconsistent objects in Hasura metadata
|
||||
- [hasura metadata inconsistency](/hasura-cli/commands/hasura_metadata_inconsistency.mdx) - Manage inconsistent objects in the Hasura Metadata
|
||||
|
||||
_Auto generated by spf13/cobra_
|
||||
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
sidebar_label: hasura metadata reload
|
||||
sidebar_position: 21
|
||||
description: Reload Hasura GraphQL Engine metadata on the database using the Hasura CLI
|
||||
description: Reload Hasura GraphQL Engine Metadata on the database using the Hasura CLI
|
||||
keywords:
|
||||
- hasura
|
||||
- docs
|
||||
@ -11,11 +11,11 @@ keywords:
|
||||
|
||||
# Hasura CLI: hasura metadata reload
|
||||
|
||||
Reload Hasura GraphQL Engine metadata on the database.
|
||||
Reload Hasura GraphQL Engine Metadata on the database.
|
||||
|
||||
## Synopsis
|
||||
|
||||
Reload Hasura GraphQL Engine metadata on the database.
|
||||
This will reload the Hasura GraphQL Engine Metadata on the database. When paired with the `--endpoint` flag, this will reload the Metadata on the specified Hasura instance.
|
||||
|
||||
```bash
|
||||
hasura metadata reload [flags]
|
||||
@ -56,6 +56,6 @@ hasura metadata export --endpoint "<endpoint>"
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
- [hasura metadata](/hasura-cli/commands/hasura_metadata.mdx) - Manage Hasura GraphQL Engine metadata saved in the database
|
||||
- [hasura metadata](/hasura-cli/commands/hasura_metadata.mdx) - Manage Hasura GraphQL Engine Metadata saved in the database
|
||||
|
||||
_Auto generated by spf13/cobra_
|
||||
|
@ -15,7 +15,11 @@ Manage migrations on the database.
|
||||
|
||||
## Synopsis
|
||||
|
||||
Manage migrations on the database.
|
||||
This command, when used with a collection of subcommands, allows you to manage migrations on the database.
|
||||
|
||||
Further reading:
|
||||
- https://hasura.io/docs/latest/migrations-metadata-seeds/manage-migrations/
|
||||
|
||||
|
||||
## Options
|
||||
|
||||
@ -43,7 +47,7 @@ Manage migrations on the database.
|
||||
|
||||
- [hasura](/hasura-cli/commands/hasura.mdx) - Hasura GraphQL Engine command line tool
|
||||
- [hasura migrate apply](/hasura-cli/commands/hasura_migrate_apply.mdx) - Apply migrations on the database
|
||||
- [hasura migrate create](/hasura-cli/commands/hasura_migrate_create.mdx) - Create files required for a migration
|
||||
- [hasura migrate create](/hasura-cli/commands/hasura_migrate_create.mdx) - Create ``sql`` files required for a migration
|
||||
- [hasura migrate delete](/hasura-cli/commands/hasura_migrate_delete.mdx) - (PREVIEW) clear migrations from local project and server
|
||||
- [hasura migrate squash](/hasura-cli/commands/hasura_migrate_squash.mdx) - (PREVIEW) Squash multiple migrations into a single one
|
||||
- [hasura migrate status](/hasura-cli/commands/hasura_migrate_status.mdx) - Display current status of migrations on a database
|
||||
|
@ -15,7 +15,11 @@ Apply migrations on the database.
|
||||
|
||||
## Synopsis
|
||||
|
||||
Apply migrations on the database.
|
||||
Migrations represent the modifications needed to reach the desired state of a database schema. Running this command will apply the migrations on the database.
|
||||
|
||||
Further reading:
|
||||
- https://hasura.io/docs/latest/migrations-metadata-seeds/manage-migrations/
|
||||
|
||||
|
||||
```bash
|
||||
hasura migrate apply [flags]
|
||||
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
sidebar_label: hasura migrate create
|
||||
sidebar_position: 24
|
||||
description: Create files required for a migration using the Hasura CLI
|
||||
description: Create ``sql`` files required for a migration using the Hasura CLI
|
||||
keywords:
|
||||
- hasura
|
||||
- docs
|
||||
@ -11,11 +11,15 @@ keywords:
|
||||
|
||||
# Hasura CLI: hasura migrate create
|
||||
|
||||
Create files required for a migration.
|
||||
Create ``sql`` files required for a migration.
|
||||
|
||||
## Synopsis
|
||||
|
||||
Create `sql` files required for a migration.
|
||||
As you make changes to your database's schema, Hasura tracks these changes via migrations. This command creates a ``sql`` file that contains the changes you made that can then be applied to a database.
|
||||
|
||||
Further reading:
|
||||
- https://hasura.io/docs/latest/migrations-metadata-seeds/manage-migrations/
|
||||
|
||||
|
||||
```bash
|
||||
hasura migrate create [migration-name] [flags]
|
||||
|
@ -15,7 +15,7 @@ keywords:
|
||||
|
||||
## Synopsis
|
||||
|
||||
(PREVIEW) clear migrations from local project and server.
|
||||
This command deletes migrations from the local project and the server. You can delete all migrations or a specific migration version by passing in the appropriate flags and values.
|
||||
|
||||
```bash
|
||||
hasura migrate delete [flags]
|
||||
|
@ -15,7 +15,7 @@ keywords:
|
||||
|
||||
## Synopsis
|
||||
|
||||
(PREVIEW) Squash multiple migrations leading up to the latest one into a single migration file.
|
||||
As you're developing your Hasura GraphQL API, you may find yourself in a situation where you have a lot of migrations that you want to squash into a single one. This command helps you do that. By running this command, you can squash all the iterative migrations you've created into a single file.
|
||||
|
||||
```bash
|
||||
hasura migrate squash [flags]
|
||||
|
@ -15,7 +15,7 @@ Display current status of migrations on a database.
|
||||
|
||||
## Synopsis
|
||||
|
||||
Display current status of migrations on a database.
|
||||
When running this command, the CLI will allow you to select which database - or all - to run the status command on. The CLI will return the current status of migrations on the selected database(s), including the version, name, source, database, and status.
|
||||
|
||||
```bash
|
||||
hasura migrate status [flags]
|
||||
|
@ -15,11 +15,9 @@ Manage plugins for the CLI.
|
||||
|
||||
## Synopsis
|
||||
|
||||
Plugins can be installed to extend the functionality of Hasura CLI
|
||||
An index for all available plugins can be found at
|
||||
https://github.com/hasura/cli-plugins-index
|
||||
The functionality of the CLI can be extended by using plugins. For a list of all available plugins, run ``hasura plugins list``, or visit this repository: https://github.com/hasura/cli-plugins-index.
|
||||
|
||||
Please open pull requests against this repo to add new plugins.
|
||||
If you're interested in contributing, please open a PR against this repo to add new plugin.
|
||||
|
||||
**Alias:** plugin
|
||||
|
||||
|
@ -15,7 +15,7 @@ Install a plugin from the index.
|
||||
|
||||
## Synopsis
|
||||
|
||||
Install a plugin from the index.
|
||||
To install plugins that extend the functionality of the Hasura CLI, you can use the install command. This command will install the plugin from the index and add it to your configuration file.
|
||||
|
||||
```bash
|
||||
hasura plugins install [plugin-name] [flags]
|
||||
@ -47,6 +47,6 @@ hasura plugins install [plugin-name]
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [hasura plugins](/hasura-cli/commands/hasura_plugins.mdx) - Manage plugins for the CLI
|
||||
- [hasura plugins](/hasura-cli/commands/hasura_plugins.mdx) - Manage plugins for the CLI
|
||||
|
||||
_Auto generated by spf13/cobra_
|
||||
|
@ -15,7 +15,7 @@ List all available plugins from index, versions and installation status.
|
||||
|
||||
## Synopsis
|
||||
|
||||
List all available plugins from index, versions and installation status.
|
||||
To see a list of all the available plugins which extend the functionality of the CLI, their versions and installation status, run the list command.
|
||||
|
||||
```bash
|
||||
hasura plugins list [flags]
|
||||
@ -53,6 +53,6 @@ hasura plugins list --dont-update-index
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [hasura plugins](/hasura-cli/commands/hasura_plugins.mdx) - Manage plugins for the CLI
|
||||
- [hasura plugins](/hasura-cli/commands/hasura_plugins.mdx) - Manage plugins for the CLI
|
||||
|
||||
_Auto generated by spf13/cobra_
|
||||
|
@ -15,7 +15,7 @@ Uninstall a plugin.
|
||||
|
||||
## Synopsis
|
||||
|
||||
Uninstall a plugin.
|
||||
To uninstall a plugin, run the uninstall command with the name of the plugin as an argument. If unsure of the plugin's name, you can run the `Hasura plugins list` command to see a list of all the available plugins.
|
||||
|
||||
```bash
|
||||
hasura plugins uninstall [plugin-name] [flags]
|
||||
@ -46,6 +46,6 @@ hasura plugins uninstall [plugin-name]
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [hasura plugins](/hasura-cli/commands/hasura_plugins.mdx) - Manage plugins for the CLI
|
||||
- [hasura plugins](/hasura-cli/commands/hasura_plugins.mdx) - Manage plugins for the CLI
|
||||
|
||||
_Auto generated by spf13/cobra_
|
||||
|
@ -15,7 +15,7 @@ Upgrade a plugin to a newer version.
|
||||
|
||||
## Synopsis
|
||||
|
||||
Upgrade a plugin to a newer version.
|
||||
To upgrade a plugin, run the upgrade command with the name of the plugin as an argument. If unsure of the plugin's name, you can run the `Hasura plugins list` command to see a list of all the available plugins.
|
||||
|
||||
```bash
|
||||
hasura plugins upgrade [flags]
|
||||
@ -47,6 +47,6 @@ hasura plugins upgrade [plugin-name]
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [hasura plugins](/hasura-cli/commands/hasura_plugins.mdx) - Manage plugins for the CLI
|
||||
- [hasura plugins](/hasura-cli/commands/hasura_plugins.mdx) - Manage plugins for the CLI
|
||||
|
||||
_Auto generated by spf13/cobra_
|
||||
|
@ -15,7 +15,7 @@ Execute helper scripts to manage Hasura Projects.
|
||||
|
||||
## Synopsis
|
||||
|
||||
Execute helper scripts to manage Hasura Projects.
|
||||
The scripts command offers a set of helper scripts to manage a Hasura project's configuration settings. This is used when upgrading between `v1`, `v2`, or `v3` configs.
|
||||
|
||||
## Options
|
||||
|
||||
|
@ -23,7 +23,7 @@ Update the Hasura Project from config v1 to v2 by executing the following action
|
||||
4. Removes all metadata yaml migrations and converts everything to SQL
|
||||
5. Exports the metadata from server in the new format (multiple files in a directory)
|
||||
6. Re-write the config.yaml file to new format
|
||||
.
|
||||
|
||||
|
||||
```bash
|
||||
hasura scripts update-project-v2 [flags]
|
||||
|
@ -15,8 +15,7 @@ Update the Hasura Project from config v2 to v3.
|
||||
|
||||
## Synopsis
|
||||
|
||||
Convenience script used to upgrade your CLI project to use config v3.
|
||||
Note that this process is completely independent from your Hasura Graphql Engine server update process.
|
||||
This helper script upgrades your CLI project to use config v3. This process is completely independent from your Hasura Graphql Engine server update process.
|
||||
|
||||
```bash
|
||||
hasura scripts update-project-v3 [flags]
|
||||
|
@ -15,7 +15,11 @@ Manage seed data.
|
||||
|
||||
## Synopsis
|
||||
|
||||
Manage seed data.
|
||||
The seed command, via its various subcommands, allows you to manage seed data for your Hasura GraphQL Engine project. Seed data is data that is used to populate your database when you run the ``hasura seed apply`` command. You can use seed data to populate your database with data that is required for your application to run. For example, you can use seed data to populate your database with an admin user that you can use to log in to your application.
|
||||
|
||||
Further reading:
|
||||
- https://hasura.io/docs/latest/migrations-metadata-seeds/manage-seeds/
|
||||
|
||||
|
||||
**Alias:** sd, seeds
|
||||
|
||||
|
@ -15,7 +15,11 @@ Apply seed data.
|
||||
|
||||
## Synopsis
|
||||
|
||||
Apply seed data.
|
||||
Run this command by passing the seed files you want to apply as arguments. If no arguments are passed, all the seed files in the seeds directory will be applied.
|
||||
|
||||
Further reading:
|
||||
- https://hasura.io/docs/latest/migrations-metadata-seeds/manage-seeds/
|
||||
|
||||
|
||||
```bash
|
||||
hasura seed apply [flags]
|
||||
@ -34,6 +38,7 @@ hasura seed apply --file 1234_add_some_seed_data.sql --database-name default
|
||||
## Options
|
||||
|
||||
```sass
|
||||
--all-databases set this flag to attempt to apply seeds on all databases present on server
|
||||
-f, --file stringArray seed file to apply
|
||||
-h, --help help for apply
|
||||
```
|
||||
|
@ -15,7 +15,11 @@ Create a new seed file.
|
||||
|
||||
## Synopsis
|
||||
|
||||
Create a new seed file.
|
||||
This will create a new seed file with the name provided as an argument. You can export tables from the database and create a seed file from it by using the ``--from-table`` flag.
|
||||
|
||||
Further reading:
|
||||
- https://hasura.io/docs/latest/migrations-metadata-seeds/manage-seeds/
|
||||
|
||||
|
||||
```bash
|
||||
hasura seed create seed_name [flags]
|
||||
|
@ -15,7 +15,7 @@ Update the CLI to latest or a specific version.
|
||||
|
||||
## Synopsis
|
||||
|
||||
Update the CLI to latest or a specific version.
|
||||
You can use this command to update the CLI to the latest version or a specific version. Each time you run a CLI command, if a new version is available, you will be prompted to update the CLI.
|
||||
|
||||
```bash
|
||||
hasura update-cli [flags]
|
||||
|
@ -15,7 +15,7 @@ Print the CLI version.
|
||||
|
||||
## Synopsis
|
||||
|
||||
Print the CLI version.
|
||||
If unsure which version of the CLI you are using, you can use this command to print the version of the CLI. This command can also be used to check if a new version of the CLI is available.
|
||||
|
||||
```bash
|
||||
hasura version [flags]
|
||||
|
Loading…
Reference in New Issue
Block a user