@@ -41,6 +41,20 @@ Search engine names and configuration:
4141![ Context menu image] ( https://github.com/Decimation/SmartImage/blob/master/Context%20menu%20integration.png )
4242
4343
44+ # Usage
45+
46+ Command line syntax:
47+
48+ ` smartimage <command> [options...] `
49+
50+ - Angle brackets (` <> ` ) specify required arguments.
51+
52+ - Square brackets (` [] ` ) specify optional arguments.
53+
54+ - Ellipses (` ... ` ) specify one or more arguments.
55+
56+ ** Behavior note** : * Any options not specified via the command line are automatically read from the configuration file.*
57+
4458# Options
4559
4660` --engines <engines> `
@@ -70,15 +84,13 @@ Automatically exits the program once searching is complete.
7084
7185Updates the configuration file with the supplied command line arguments.
7286
73- # Behavior
7487
75- Any options not specified via the command line are automatically read from the configuration file.
7688
77- # Verbs
89+ # Commands
7890
79- ` image <image path>`
91+ ` search <image path> [options...] `
8092
81- (Default verb, explicitly specifying this verb is not needed) .
93+ This is the default functionality. Explicitly specifying this is not needed.
8294
8395` ctx-menu <add/remove> `
8496
@@ -92,13 +104,13 @@ Adds or removes executable path to path environment variable.
92104
93105Removes integrations. Specify ` all ` to additionally reset configuration.
94106
95- ` create-sn [auto ] `
107+ ` create-sn [true/false ] `
96108
97- Register a SauceNao account (for API keys). Specify ` auto ` to autofill registration fields.
109+ Register a SauceNao account (for API keys). Specify ` true ` to autofill registration fields.
98110
99111` info `
100112
101- Information about the program and its configuration.
113+ Displays information about the program and its configuration.
102114
103115` help `
104116
@@ -108,7 +120,29 @@ Display available commands.
108120
109121Display program version.
110122
123+ # Usage examples
124+
125+ ` smartimage --engines All --priority-engines None "image.jpg" `
126+
127+ Runs the program using all search engines and no results will be in the browser.
128+
129+ ` smartimage --engines SauceNao,ImgOps,GoogleImages --priority-engines SauceNao "image.jpg" `
130+
131+ Runs the program using SauceNao, ImgOps, and Google Images. The best result from SauceNao will be opened in the browser.
132+
133+ ` smartimage --engines SauceNao,ImgOps,KarmaDecay --priority-engines SauceNao --update-cfg "image.jpg" `
134+
135+ Runs the program using SauceNao, ImgOps, and Karma Decay. The best result from SauceNao will be opened in the browser.
136+ The specified options will be saved to the configuration file.
137+
138+ ` smartimage create-sn true `
139+
140+ Automatically creates a SauceNao account for usage. Account information is stored in a text file in the current directory and the
141+ API key is saved to the configuration file.
142+
143+ ` smartimage reset all `
111144
145+ Fully resets configuration and removes all integrations.
112146
113147# Notes
114148
0 commit comments