neocities_cli.html 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <link rel="icon" type="image/png" href="logo.png" />
  5. <title>Neocities' CLI</title>
  6. <link href="style.css" rel="stylesheet" type="text/css" media="all">
  7. <!-- -->
  8. <!-- Because you are reading this, it must mean only one thing; you -->
  9. <!-- are looking at our page source, well, hope you like the -->
  10. <!-- look of it! -->
  11. <!-- -->
  12. <!-- The Penny's Pages Wiki was made by members of the Neocities -->
  13. <!-- webhost, for your enjoyment, and our pain. We hope that you are -->
  14. <!-- enjoying reading our articles. -->
  15. <!-- -->
  16. <!-- Penny's Pages is composed of original material, and may be used -->
  17. <!-- as long as you follow CC BY-NC-SA 3.0 -->
  18. <!-- -->
  19. <!-- Our URL: https://thewikion.neocities.org/ -->
  20. <!-- -->
  21. <!-- Enjoy the rest of your night, young Internet search astronaut! -->
  22. <!-- -->
  23. <h1>Neocities' CLI</h1>
  24. <div class="tag">
  25. <img src="img/wikipedia.png" align=left hspace=15 vspace=5>
  26. <p>
  27. <h3>The majority of this article uses text form Wikipedia or a similar wikia.</h3>
  28. Most, or a lot of the text on this page is taken from <a href="https://minerobber.neocities.org/neowiki/neocities_cli.html" target="_blank">neowiki</a>, try and make most of the article original.
  29. <p>
  30. <p><hr></hr>
  31. <tt>04/09/18</tt>
  32. </div></style>
  33. <p>
  34. A command-line interface or command language interpreter (CLI), also known as command-line user interface, console user interface, and character user interface (CUI), is a means of interacting with a computer program where the user (or client) issues commands to the program in the form of successive lines of text (command lines). A program which handles the interface is called a command language interpreter or shell (computing).</p>
  35. <p>
  36. The <a href="https://neocities.org/cli">Neocities CLI</a> is a utility written in the <a href="https://en.wikipedia.org/wiki/Ruby_%28programming_language%29" target="_blank">Ruby programming language</A> to interface with the Neocities API from a terminal. It allows a website to be managed entirely through the console, without the use of a web browser.</p>
  37. <p>
  38. <h2><a href="#Installation">Installation</a><a name="Installation"></a></h2>
  39. The Neocities CLI runs on any platform with <a href="https://www.ruby-lang.org/en/downloads/" target="_blank">Ruby, and its Gem package manager</a> installed. Run <tt>gem install neocities</tt> and it will install.</p>
  40. <p>
  41. In the case of macOS or Linux users, the page on Neocities' website advises to run it with <tt>sudo</tt> if there are permissions issues. If the installation has an error about <tt>rake</tt> not being installed, run <tt>gem install rake</tt> before trying again.</p>
  42. <h2><a href="#Usage">Usage</a><a name="Usage"></a></h2>
  43. <p>
  44. Using any of the Neocities CLI's functions will prompt you to enter your site's username and password. After this, it will store the API key and you won't need to enter it again.</p>
  45. <p>
  46. A full list of the CLI's functions can be found by just typing <tt>neocities</tt> into the terminal.</p>
  47. <p>
  48. If you have an existing site, you may want to download and extract it first through the Neocities dashboard, so you can jump into editing right away.</p>
  49. <p>
  50. You can push the entire directory to your site by going to the folder and running <tt>neocities push .</tt>.</p>
  51. <p>
  52. Additionally, you can upload files (<tt>neocities upload</tt>), delete files (<tt>neocities delete</tt>), list your files (<tt>neocities list</tt>), get stats (<tt>neocities info</tt>), or log out (<tt>neocities logout</tt>).</p>
  53. <hr>
  54. <tt>
  55. References<br>
  56. I. Command-line interface<br>
  57. <a href="https://en.wikipedia.org/wiki/Command-line_interface">https://en.wikipedia.org/wiki/Command-line_interface</a>
  58. <br>
  59. II. neowiki article</br>
  60. <a href="https://minerobber.neocities.org/neowiki/neocities_cli.html">https://minerobber.neocities.org/neowiki/neocities_cli.html</a>
  61. <br>
  62. III. Neocities' Cli</br>
  63. <a href="https://neocities.org/cli">https://neocities.org/cli</a>
  64. <br>
  65. III. neocities/neocities-ruby - The Github repository for the CLI</br>
  66. <a href="https://github.com/neocities/neocities-ruby">https://github.com/neocities/neocities-ruby</a>
  67. <p>This page was last updated: 04/09/2018 @ 17:05</p>
  68. <p>In total this page has had 0 updates since it was uploaded.</p>
  69. </tt>
  70. <font color="black"><center>&#x2605;</center></font>
  71. </body>
  72. </html>