📝 Add examples to commands reference

Author: julien040

cmd/alias.go

@@ -12,6 +12,14 @@ var aliasCmd = &cobra.Command{
 They help you use another name for a table so that you don't have to write profileName_pluginName_tableName every time.`,
 	Aliases: []string{"aliases"},
 	RunE:    controller.AliasList,
+	Example: `# List the aliases
+anyquery alias
+
+# Add an alias
+anyquery alias add myalias mytable
+
+# Delete an alias
+anyquery alias delete myalias`,
 }
 
 var aliasAddCmd = &cobra.Command{
@@ -20,7 +28,8 @@ var aliasAddCmd = &cobra.Command{
 	Short:   "Add an alias",
 	Long: `Add an alias.
 The alias name must be unique and not already used by a table.`,
-	RunE: controller.AliasAdd,
+	RunE:    controller.AliasAdd,
+	Example: `anyquery alias add myalias mytable`,
 }
 
 var aliasDeleteCmd = &cobra.Command{
@@ -29,6 +38,7 @@ var aliasDeleteCmd = &cobra.Command{
 	Aliases: []string{"rm", "remove"},
 	Args:    cobra.MaximumNArgs(1),
 	RunE:    controller.AliasDelete,
+	Example: `anyquery alias delete myalias`,
 }
 
 var aliasListCmd = &cobra.Command{

cmd/plugins.go

@@ -22,6 +22,7 @@ var pluginInstallCmd = &cobra.Command{
 	Args:       cobra.MaximumNArgs(2),
 	SuggestFor: []string{"get"},
 	RunE:       controller.PluginInstall,
+	Example:    `anyquery plugin install github`,
 }
 
 var pluginUninstallCmd = &cobra.Command{
@@ -32,13 +33,15 @@ var pluginUninstallCmd = &cobra.Command{
 	Aliases: []string{"rm", "remove", "delete"},
 	Args:    cobra.MinimumNArgs(1),
 	RunE:    controller.PluginUninstall,
+	Example: `anyquery plugin uninstall github`,
 }
 
 var pluginUpdateCmd = &cobra.Command{
-	Use:   "update [...plugin]",
-	Short: "Update n or all plugins",
-	Long:  "Update plugins\nIf no plugin is specified, all plugins will be updated",
-	RunE:  controller.PluginUpdate,
+	Use:     "update [...plugin]",
+	Short:   "Update n or all plugins",
+	Long:    "Update plugins\nIf no plugin is specified, all plugins will be updated",
+	RunE:    controller.PluginUpdate,
+	Example: `anyquery registry refresh && anyquery plugin update github`,
 }
 
 func init() {

cmd/profiles.go

@@ -12,6 +12,8 @@ var profilesCmd = &cobra.Command{
 Alias to profile list.`,
 	Aliases: []string{"profile"},
 	RunE:    controller.ProfileList,
+	Example: `# List the profiles
+anyquery profiles`,
 }
 
 var profilesUpdateCmd = &cobra.Command{
@@ -22,7 +24,8 @@ var profilesUpdateCmd = &cobra.Command{
 If only two arguments are provided, we consider that the registry is the default one.
 If no argument is provided, the command will prompt you the registry, the plugin and the profile to update.
 Note: This command requires the tty to be interactive.`,
-	RunE: controller.ProfileUpdate,
+	RunE:    controller.ProfileUpdate,
+	Example: `anyquery profiles update default github myprofile`,
 }
 
 var profilesNewCmd = &cobra.Command{
@@ -35,6 +38,7 @@ If no argument is provided, the command will prompt you the registry, the plugin
 Note: This command requires the tty to be interactive.`,
 	RunE:    controller.ProfileNew,
 	Aliases: []string{"create", "add"},
+	Example: `anyquery profiles new default github default`,
 }
 
 var profilesListCmd = &cobra.Command{
@@ -47,6 +51,7 @@ If only one argument is provided, the results will be filtered by the registry.
 If two arguments are provided, the results will be filtered by the registry and the plugin.`,
 	Aliases: []string{"ls"},
 	RunE:    controller.ProfileList,
+	Example: `anyquery profiles list`,
 }
 
 var profilesDeleteCmd = &cobra.Command{
@@ -58,6 +63,7 @@ If only two arguments are provided, we consider that the registry is the default
 If no argument is provided, the command will prompt you the registry, the plugin and the profile to create.`,
 	Aliases: []string{"rm", "remove"},
 	RunE:    controller.ProfileDelete,
+	Example: `anyquery profiles delete default github default`,
 }
 
 func init() {

cmd/query.go

@@ -13,6 +13,17 @@ The query can be specified as an argument or read from stdin.
 If no query is provided, the command will launch an interactive input.`,
 	RunE:    controller.Query,
 	Aliases: []string{"q", "run"},
+	Example: `# Run a one-off query
+anyquery query -d mydatabase.db -q "SELECT * FROM mytable"
+
+# Open the interactive shell
+anyquery query -d mydatabase.db
+
+# Open the interactive shell in memory
+anyquery query
+
+# Query from stdin
+echo "SELECT * FROM mytable" | anyquery query -d mydatabase.db`,
 }
 
 func init() {

cmd/registry.go

@@ -12,13 +12,15 @@ var registryCmd = &cobra.Command{
 	Aliases:    []string{"registries"},
 	SuggestFor: []string{"store"},
 	Args:       cobra.NoArgs,
+	Example:    "anyquery registry list",
 }
 
 var registryListCmd = &cobra.Command{
 	Use:     "list",
 	Short:   "List the registries where plugins can be downloaded",
 	RunE:    controller.RegistryList,
 	Aliases: []string{"ls"},
+	Example: "anyquery registry list",
 }
 
 var registryAddCmd = &cobra.Command{
@@ -27,13 +29,15 @@ var registryAddCmd = &cobra.Command{
 	Args:    cobra.MaximumNArgs(2),
 	RunE:    controller.RegistryAdd,
 	Aliases: []string{"new", "create", "register", "install"},
+	Example: "anyquery registry add internal_reg https://registry.anyquery.dev/v0/registry/",
 }
 
 var registryRemoveCmd = &cobra.Command{
 	Use:     "remove",
 	Short:   "Remove a registry",
 	RunE:    controller.RegistryRemove,
 	Aliases: []string{"rm", "delete"},
+	Example: "anyquery registry remove internal_reg",
 }
 
 var registryGetCmd = &cobra.Command{
@@ -42,6 +46,7 @@ var registryGetCmd = &cobra.Command{
 	Args:    cobra.ExactArgs(1),
 	RunE:    controller.RegistryGet,
 	Aliases: []string{"info", "show", "inspect"},
+	Example: "anyquery registry get internal_reg",
 }
 
 var registryRefreshCmd = &cobra.Command{
@@ -52,6 +57,7 @@ If a name is provided, only this registry will be refreshed. Otherwise, all regi
 	Args:    cobra.MaximumNArgs(1),
 	RunE:    controller.RegistryRefresh,
 	Aliases: []string{"update", "sync", "fetch", "pull"},
+	Example: "anyquery registry refresh",
 }
 
 func init() {

cmd/root.go

@@ -17,13 +17,13 @@ by writing SQL queries. It can be extended with plugins`,
 	// Thanks https://github.com/spf13/cobra/issues/340#issuecomment-243790200
 	SilenceUsage: true,
 	RunE:         controller.Query,
-	Example: `-- Run a one-off query
+	Example: `# Run a one-off query
 anyquery -d mydatabase.db -q "SELECT * FROM mytable"
 
--- Open the interactive shell
+# Open the interactive shell
 anyquery -d mydatabase.db
 
--- Open a database in memory
+# Open a database in memory
 anyquery -d ":memory:"
 `,
 }

cmd/server.go

@@ -11,6 +11,17 @@ var serverCmd = &cobra.Command{
 	Long: `Listens for incoming connections and allows you to run queries
 using any MySQL client.`,
 	RunE: controller.Server,
+	Example: `# Start the server by opening anyquery.db by default
+anyquery server 
+
+# Start the server on a specific host and port
+anyquery server --host 127.0.0.1 --port 3306
+
+# Start the server with a specific database
+anyquery server -d mydatabase.db
+
+# Increase the log level and redirect the output to a file
+anyquery server --log-level debug --log-file /var/log/anyquery.log`,
 }
 
 func init() {

cmd/tool.go

@@ -27,6 +27,7 @@ The password is hashed using the mysql_native_password algorithm
 which can be summarized as HEX(SHA1(SHA1(password)))`,
 	Aliases: []string{"hash-password", "mysql-native-password"},
 	RunE:    controller.MySQLPassword,
+	Example: `echo "password" | anyquery tool mysql-password`,
 }
 
 var toolDevCmd = &cobra.Command{
@@ -42,6 +43,8 @@ var toolDevInitCmd = &cobra.Command{
 	The module URL is the go mod URL of the plugin.`,
 	Args: cobra.RangeArgs(1, 2),
 	RunE: controller.DevInit,
+	Example: `# Initialize a new plugin in a new directory,
+anyquery tool dev init github.com/julien040/anyquery/plugins/voynich-manuscript voynich-manuscript`,
 }
 
 var toolDevNewTableCmd = &cobra.Command{
@@ -52,18 +55,21 @@ var toolDevNewTableCmd = &cobra.Command{
 	The table name must only contain alphanumeric characters and underscores. Other characters will be replaced by underscores.`,
 	Args: cobra.ExactArgs(1),
 	RunE: controller.DevNewTable,
+	Example: `# Inside the plugin directory, create a new table file
+anyquery tool dev new-table my_table`,
 }
 
 var toolGenerateDocCmd = &cobra.Command{
 	Use:   "generate-doc [dir]",
 	Short: "Generate the markdown documentation of the CLI",
-	Args: cobra.ExactArgs(1),
+	Args:  cobra.ExactArgs(1),
 	RunE: func(cmd *cobra.Command, args []string) error {
 		return doc.GenMarkdownTree(rootCmd, args[0])
 	},
+	Example: `# Generate the doc in the docs directory
+anyquery tool generate-doc docs`,
 }
 
-
 func init() {
 	rootCmd.AddCommand(toolCmd)
 	toolCmd.AddCommand(toolHashDirCmd)

website/src/content/docs/docs/reference/Commands/anyquery.md

@@ -10,13 +10,27 @@ A tool to query any data source
 Anyquery allows you to query any data source
 by writing SQL queries. It can be extended with plugins
 
-```
+```bash
 anyquery [database] [query] [flags]
 ```
 
-### Options
+### Examples
+
+```bash
+# Run a one-off query
+anyquery -d mydatabase.db -q "SELECT * FROM mytable"
+
+# Open the interactive shell
+anyquery -d mydatabase.db
+
+# Open a database in memory
+anyquery -d ":memory:"
 
 ```
+
+### Options
+
+```bash
   -c, --config string       Path to the configuration database
       --csv                 Output format as CSV
   -d, --database string     Database to connect to (a path or :memory:)
@@ -38,7 +52,6 @@ anyquery [database] [query] [flags]
   -q, --query string        Query to run
       --read-only           Start the server in read-only mode
       --readonly            Start the server in read-only mode
-  -v, --version             Print the version of the program
 ```
 
 ### SEE ALSO

website/src/content/docs/docs/reference/Commands/anyquery_alias.md

@@ -10,13 +10,26 @@ Manage the aliases
 Manage the aliases.
 They help you use another name for a table so that you don't have to write profileName_pluginName_tableName every time.
 
-```
+```bash
 anyquery alias [flags]
 ```
 
-### Options
+### Examples
+
+```bash
+# List the aliases
+anyquery alias
+
+# Add an alias
+anyquery alias add myalias mytable
 
+# Delete an alias
+anyquery alias delete myalias
 ```
+
+### Options
+
+```bash
   -c, --config string   Path to the configuration database
       --csv             Output format as CSV
       --format string   Output format (pretty, json, csv, plain)

website/src/content/docs/docs/reference/Commands/anyquery_alias_add.md

@@ -10,19 +10,25 @@ Add an alias
 Add an alias.
 The alias name must be unique and not already used by a table.
 
-```
+```bash
 anyquery alias add [alias] [table] [flags]
 ```
 
-### Options
+### Examples
 
+```bash
+anyquery alias add myalias mytable
 ```
+
+### Options
+
+```bash
   -h, --help   help for add
 ```
 
 ### Options inherited from parent commands
 
-```
+```bash
   -c, --config string   Path to the configuration database
 ```
 

website/src/content/docs/docs/reference/Commands/anyquery_alias_delete.md

@@ -5,19 +5,25 @@ description: Learn how to use the anyquery alias delete command in AnyQuery.
 
 Delete an alias
 
-```
+```bash
 anyquery alias delete [alias] [flags]
 ```
 
-### Options
+### Examples
 
+```bash
+anyquery alias delete myalias
 ```
+
+### Options
+
+```bash
   -h, --help   help for delete
 ```
 
 ### Options inherited from parent commands
 
-```
+```bash
   -c, --config string   Path to the configuration database
 ```
 

website/src/content/docs/docs/reference/Commands/anyquery_alias_list.md

@@ -5,13 +5,13 @@ description: Learn how to use the anyquery alias list command in AnyQuery.
 
 List the aliases
 
-```
+```bash
 anyquery alias list [flags]
 ```
 
 ### Options
 
-```
+```bash
       --csv             Output format as CSV
       --format string   Output format (pretty, json, csv, plain)
   -h, --help            help for list
@@ -21,7 +21,7 @@ anyquery alias list [flags]
 
 ### Options inherited from parent commands
 
-```
+```bash
   -c, --config string   Path to the configuration database
 ```