Help:Using the command line: Difference between revisions
Jump to navigation
Jump to search
bold
imported>Leoetlino (Created page with "Many recent tools are wikipedia:command-line interface (CLI) based because such interfaces are usually more powerful, efficient, easier to use for batch processing, and a...") |
imported>Leoetlino (bold) |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 7: | Line 7: | ||
== On Windows == | == On Windows == | ||
If you are on Windows, you have probably never used a command line in your life. Fear not; that using the CLI is hard is a stereotype. It is ''not'' true in particular for BotW-related tools, which are fairly simple to manipulate. | If you are on Windows, you have probably never used a command line in your life. Fear not; that using the CLI is hard is a stereotype. It is ''not'' true in particular for BotW-related tools, which are fairly simple to manipulate. Tools will almost always have documentation that tells you how to use them too. | ||
=== Opening a command line === | === Opening a command line === | ||
| Line 26: | Line 26: | ||
command_name argument_1 argument_2 argument_3 ... | command_name argument_1 argument_2 argument_3 ... | ||
The first word is the command name. It is the name of the program you are going to invoke. | The first word is the '''command name'''. It is the name of the program you are going to invoke. | ||
Anything that comes after from are arguments. They tell the program what it should do or what to operate on. For example, the copy command takes the source file as the first parameter and the destination file as the second. You would type: | Anything that comes after from are '''arguments'''. They tell the program what it should do or what to operate on. For example, the copy command takes the source file as the first parameter and the destination file as the second. You would type: | ||
copy C:/source_file C:/destination | copy C:/source_file C:/destination | ||
'''and press Enter to run the command''' and copy C:/source_file to C:/destination. | '''and press Enter to run the command''' and copy C:/source_file to C:/destination. | ||
==== On options ==== | |||
What about optional parameters? And what if a command takes a large amount of parameters? To avoid requiring the user to memorise the argument order when there are too many, CLI utilities typically use options. | |||
'''Options are just another way to give parameters.''' They almost always have the following form: <code>--optionname option_value</code>, can usually be combined and reordered, and are usually optional. | |||
==== On paths ==== | ==== On paths ==== | ||
| Line 41: | Line 46: | ||
''See [[Help:Setting up tools]] for installing Python.'' | ''See [[Help:Setting up tools]] for installing Python.'' | ||
* Instructions on this wiki will often use the <code>python3</code> command. Replace <code>python3</code> with <code>py -3</code> on Windows. | * Instructions on this wiki will often use the <code>python3</code> command. '''Replace <code>python3</code> with <code>py -3</code> on Windows.''' | ||
* To install a package, use <code>py -3 -m pip install <package name></code>. For example, to install eventeditor, run <code>py -3 -m pip install eventeditor</code>. | * To '''install a package''', use <code>py -3 -m pip install <package name></code>. For example, to install eventeditor, run <code>py -3 -m pip install eventeditor</code>. | ||
[[Category:Guides]] | [[Category:Guides]] | ||