add examples to all cli commands (#3475) #3492

ashishra0 · 2019-12-05T05:38:51Z

Description

Add examples to Hasura CLI commands #3475

Affected components

CLI

hasura-bot · 2019-12-05T05:38:54Z

Beep boop! 🤖

Hey @ashishra0, thanks for your PR!

One of my human friends will review this PR and get back to you as soon as possible.

Stay awesome! 😎

claassistantio · 2019-12-05T05:39:10Z

All committers have signed the CLA.

netlify · 2019-12-05T05:40:01Z

Deploy preview for hasura-docs ready!

Built with commit 8672d14

https://deploy-preview-3492--hasura-docs.netlify.com

hasura-bot · 2019-12-05T05:57:24Z

Review app for commit e7ae33a deployed to Heroku: https://hge-ci-pull-3492.herokuapp.com
Docker image for server: hasura/graphql-engine:pull3492-e7ae33a2

cli/commands/console.go

shahidhk · 2019-12-05T07:00:55Z

cli/commands/console.go

+	# Start console without opening the browser automatically
+	hasura console --no-browser
+
+	# Apply admin secret for Hasura GraphQL Engine:


Suggested change

# Apply admin secret for Hasura GraphQL Engine:

# Use with admin secret:

shahidhk · 2019-12-05T07:02:03Z

cli/commands/console.go

+	# Apply admin secret for Hasura GraphQL Engine:
+	hasura console --admin-secret "<admin-secret>"
+
+	# Add Hasura GraphQL Server endpoint:


Suggested change

# Add Hasura GraphQL Server endpoint:

# Connect to an instance specified by the falg, over-rides the one mentioned in config.yaml

shahidhk · 2019-12-05T07:02:38Z

cli/commands/console.go

+	hasura console --admin-secret "<admin-secret>"
+
+	# Add Hasura GraphQL Server endpoint:
+	hasura console --admin-secret "<admin-secret>"`,


Use --endpoint instead of admin secret (repetition)

cli/commands/metadata_apply.go

shahidhk · 2019-12-05T07:30:23Z

cli/commands/migrate_squash.go

+	hasura migrate squash --endpoint "<http-endpoint>"
+
+	# Add a name for the new squashed migration
+	hasura migrate squash --name "<name>"`,


Suggested change

hasura migrate squash --name "<name>"`,

hasura migrate squash --name "<name>" --from 123`,

shahidhk · 2019-12-05T07:30:41Z

cli/commands/migrate_status.go

+		# Create migration files from server:
+		hasura migrate create "<filename>" --from-server


Remove this

shahidhk · 2019-12-05T07:30:58Z

cli/commands/migrate_status.go

+		# Create migration files from server:
+		hasura migrate create "<filename>" --from-server
+
+		# Add admin secret for Hasura GraphQL Engine:


Suggested change

# Add admin secret for Hasura GraphQL Engine:

# Use with admin secret:

shahidhk · 2019-12-05T07:31:31Z

cli/commands/migrate_status.go

+		# Add admin secret for Hasura GraphQL Engine:
+		hasura migrate status --admin-secret "<your-admin-secret>"
+
+		# Add Hasura GraphQL Server endpoint:


Suggested change

# Add Hasura GraphQL Server endpoint:

# Check status on a different server:

shahidhk · 2019-12-05T07:31:46Z

cli/commands/migrate_status.go

+		hasura migrate status --admin-secret "<your-admin-secret>"
+
+		# Add Hasura GraphQL Server endpoint:
+		hasura migrate status --endpoint "<http-endpoint>"`,


Suggested change

hasura migrate status --endpoint "<http-endpoint>"`,

hasura migrate status --endpoint "<endpoint>"`,

hasura-bot · 2019-12-05T09:31:02Z

Review app for commit 453d195 deployed to Heroku: https://hge-ci-pull-3492.herokuapp.com
Docker image for server: hasura/graphql-engine:pull3492-453d1956

shahidhk

@ashishra0 Check the indentation across all files and the review comments specificatlly

shahidhk · 2019-12-10T07:33:14Z

cli/commands/console.go

@@ -30,11 +30,21 @@ func NewConsoleCmd(ec *cli.ExecutionContext) *cobra.Command {
 		Use:   "console",
 		Short: "Open console to manage database and try out APIs",
 		Long:  "Run a web server to serve Hasura Console for GraphQL Engine to manage database and build queries",
-		Example: `  # Start console:
+		Example: `


Indentation is with tabs and spaces mixed here.
Always use two spaces to indent multiline strings.

shahidhk · 2019-12-10T07:33:45Z

cli/commands/console.go

+	# Use with admin secret:
+	hasura console --admin-secret "<admin-secret>"
+
+	# Connect to an instance specified by the flag, over-rides the one mentioned in config.yaml:


override is a single word

shahidhk · 2019-12-10T07:34:35Z

cli/commands/metadata_apply.go

-		Example: `  # Apply Hasura GraphQL Engine metadata present in metadata.[yaml|json] file:
-  hasura metadata apply`,
+		Example: `
+	# Apply Hasura GraphQL Engine metadata present in metadata.[yaml|json] file:


Change these to spaces. 1st line should start after the backquote and two spaces.

shahidhk · 2019-12-10T07:35:51Z

cli/commands/metadata_clear.go

@@ -18,8 +18,15 @@ func newMetadataClearCmd(ec *cli.ExecutionContext) *cobra.Command {
 		Use:     "clear",
 		Aliases: []string{"reset"},
 		Short:   "Clear Hasura GraphQL Engine metadata on the database",
-		Example: `  # Clear all the metadata information from database:
-  hasura metadata clear`,
+		Example: `


Change these too to spaces.

shahidhk · 2019-12-10T07:36:36Z

cli/commands/metadata_export.go

@@ -23,8 +23,15 @@ func newMetadataExportCmd(ec *cli.ExecutionContext) *cobra.Command {
 	metadataExportCmd := &cobra.Command{
 		Use:   "export",
 		Short: "Export Hasura GraphQL Engine metadata from the database",
-		Example: `  # Export metadata and save it in migrations/metadata.yaml file:
-  hasura metadata export`,
+		Example: `


Indentation issues here too.

hasura-bot · 2019-12-10T09:58:12Z

Review app for commit 8672d14 deployed to Heroku: https://hge-ci-pull-3492.herokuapp.com
Docker image for server: hasura/graphql-engine:pull3492-8672d144

hasura-bot · 2019-12-12T05:16:39Z

Review app https://hge-ci-pull-3492.herokuapp.com is deleted

hasura-bot · 2019-12-12T05:16:40Z

Beep boop! 🤖

Awesome work @ashishra0! All of us at Hasura ❤️ what you did.

Thanks again 🤗

ashishra0 added 3 commits December 5, 2019 10:48

add examples including flags

67de1ab

add examples including flags

2795a6d

add pending examples with flags

e7ae33a

ashishra0 requested a review from shahidhk as a code owner December 5, 2019 05:38

shahidhk changed the title ~~Cli commands example (#3475)~~ add examples to all cli commands (#3475) Dec 5, 2019

shahidhk requested changes Dec 5, 2019

View reviewed changes

ashishra0 added 10 commits December 5, 2019 14:40

fix indentation and typos

20288d2

fix indentation and typos

c1575f1

fix indentation and typos

005dc53

fix indentation and typos

5699394

fix indentation and typos

fcab0b3

fix indentation and typos

1a9dc91

fix entire block indentation and flag typos

2752abe

fix indentation

0e582e5

fix flag typos

5c70fbd

add proper flag names

453d195

marionschleifer added the c/docs Related to docs label Dec 6, 2019

shahidhk requested changes Dec 10, 2019

View reviewed changes

fix code indentation

8672d14

shahidhk approved these changes Dec 12, 2019

View reviewed changes

shahidhk merged commit b183eba into hasura:master Dec 12, 2019

shahidhk added the c/cli Related to CLI label Dec 12, 2019

polRk pushed a commit to polRk/graphql-engine that referenced this pull request Feb 12, 2020

add examples to all cli commands (hasura#3475) (hasura#3492)

128b11c

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add examples to all cli commands (#3475) #3492

add examples to all cli commands (#3475) #3492

ashishra0 commented Dec 5, 2019

hasura-bot commented Dec 5, 2019

claassistantio commented Dec 5, 2019 •

edited

Loading

netlify bot commented Dec 5, 2019 •

edited

Loading

hasura-bot commented Dec 5, 2019

shahidhk Dec 5, 2019

shahidhk Dec 5, 2019

shahidhk Dec 5, 2019

shahidhk Dec 5, 2019

shahidhk Dec 5, 2019

shahidhk Dec 5, 2019

shahidhk Dec 5, 2019

shahidhk Dec 5, 2019

hasura-bot commented Dec 5, 2019

shahidhk left a comment

shahidhk Dec 10, 2019

shahidhk Dec 10, 2019

shahidhk Dec 10, 2019

shahidhk Dec 10, 2019

shahidhk Dec 10, 2019

hasura-bot commented Dec 10, 2019

hasura-bot commented Dec 12, 2019

hasura-bot commented Dec 12, 2019

	# Apply admin secret for Hasura GraphQL Engine:
	# Use with admin secret:

	# Add Hasura GraphQL Server endpoint:
	# Connect to an instance specified by the falg, over-rides the one mentioned in config.yaml

	hasura migrate squash --name "<name>"`,
	hasura migrate squash --name "<name>" --from 123`,

		# Create migration files from server:
		hasura migrate create "<filename>" --from-server

	# Add admin secret for Hasura GraphQL Engine:
	# Use with admin secret:

	# Add Hasura GraphQL Server endpoint:
	# Check status on a different server:

	hasura migrate status --endpoint "<http-endpoint>"`,
	hasura migrate status --endpoint "<endpoint>"`,

add examples to all cli commands (#3475) #3492

add examples to all cli commands (#3475) #3492

Conversation

ashishra0 commented Dec 5, 2019

Description

Affected components

hasura-bot commented Dec 5, 2019

claassistantio commented Dec 5, 2019 • edited Loading

netlify bot commented Dec 5, 2019 • edited Loading

hasura-bot commented Dec 5, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hasura-bot commented Dec 5, 2019

shahidhk left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hasura-bot commented Dec 10, 2019

hasura-bot commented Dec 12, 2019

hasura-bot commented Dec 12, 2019

claassistantio commented Dec 5, 2019 •

edited

Loading

netlify bot commented Dec 5, 2019 •

edited

Loading