mirror of
https://github.com/neocities/neocities.git
synced 2025-04-24 17:22:35 +02:00
add information on the Neocities CLI
This commit is contained in:
parent
e6deaa05b9
commit
19b325b278
4 changed files with 67 additions and 3 deletions
|
@ -133,6 +133,10 @@ get '/thankyou' do
|
||||||
erb :'thankyou'
|
erb :'thankyou'
|
||||||
end
|
end
|
||||||
|
|
||||||
|
get '/cli' do
|
||||||
|
erb :'cli'
|
||||||
|
end
|
||||||
|
|
||||||
get '/forgot_username' do
|
get '/forgot_username' do
|
||||||
erb :'forgot_username'
|
erb :'forgot_username'
|
||||||
end
|
end
|
||||||
|
|
|
@ -11,6 +11,7 @@
|
||||||
<li><a href="/about">About</a></li>
|
<li><a href="/about">About</a></li>
|
||||||
<li><a href="/donate">Donate</a></li>
|
<li><a href="/donate">Donate</a></li>
|
||||||
<% unless is_education? %>
|
<% unless is_education? %>
|
||||||
|
<li><a href="/cli">CLI</a></li>
|
||||||
<li><a href="//blog.neocities.org">Blog</a></li>
|
<li><a href="//blog.neocities.org">Blog</a></li>
|
||||||
<li><a href="/api">API</a></li>
|
<li><a href="/api">API</a></li>
|
||||||
<li><a href="/press">Press</a></li>
|
<li><a href="/press">Press</a></li>
|
||||||
|
|
59
views/cli.erb
Normal file
59
views/cli.erb
Normal file
|
@ -0,0 +1,59 @@
|
||||||
|
<div class="header-Outro">
|
||||||
|
<div class="row content single-Col">
|
||||||
|
<h1>The Neocities CLI</h1>
|
||||||
|
<h2 class="subtitle">Manage your site using a shell terminal</h2>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="content single-Col misc-page">
|
||||||
|
<article role="article">
|
||||||
|
<p>Neocities has a CLI for power users that want to upload sites using a command line.</p>
|
||||||
|
|
||||||
|
<h2>Features</h2>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><strong>Push support</strong> - uploads an entire directory. Great for static site generators.
|
||||||
|
<li><strong>HTTP persistence</strong> - the CLI reuses a single HTTP connection, improving performance.
|
||||||
|
<li><strong>Check before upload</strong> - checks if the file data matches before uploading.
|
||||||
|
<li><strong>Gitignore parsing</strong> - automatically skips files in root gitignore file for git repositories.
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h2>Install Instructions</h2>
|
||||||
|
|
||||||
|
<p>If you're using a newer version of OSX or already have <a href="https://www.ruby-lang.org/">Ruby</a> installed, just run this command to install:</p>
|
||||||
|
|
||||||
|
<code>gem install neocities</code>
|
||||||
|
|
||||||
|
<p>If you get a permission error, you may need to run the command as superuser:</p>
|
||||||
|
|
||||||
|
<code>sudo gem install neocities</code>
|
||||||
|
|
||||||
|
<p>After installation, just run the command to get started:</p>
|
||||||
|
|
||||||
|
<pre>$ neocities
|
||||||
|
|
||||||
|
|\---/|
|
||||||
|
| o_o | Neocities
|
||||||
|
\_-_/
|
||||||
|
|
||||||
|
Subcommands:
|
||||||
|
push Recursively upload a local directory to your site
|
||||||
|
upload Upload individual files to your Neocities site
|
||||||
|
delete Delete files from your Neocities site
|
||||||
|
list List files from your Neocities site
|
||||||
|
info Information and stats for your site
|
||||||
|
logout Remove the site api key from the config</pre>
|
||||||
|
|
||||||
|
<h2>Windows</h2>
|
||||||
|
|
||||||
|
<p>If you're using Windows, you can install ruby with something like the <a href="https://rubyinstaller.org/">Ruby Installer</a>, and then run the above command.</p>
|
||||||
|
|
||||||
|
<h2>Linux / BSD</h2>
|
||||||
|
|
||||||
|
<p>Most Linux / BSD distributions come with Ruby packages. For example, with Ubuntu:</p>
|
||||||
|
|
||||||
|
<code>sudo apt-get install ruby-full</code>
|
||||||
|
|
||||||
|
A full list of available install options for ruby is <a href="https://www.ruby-lang.org/en/documentation/installation/">here</a>.
|
||||||
|
</article>
|
||||||
|
</div>
|
|
@ -53,14 +53,14 @@
|
||||||
<div class="col intro">
|
<div class="col intro">
|
||||||
<h2 class="section-header">Create your own free website.<br>Unlimited creativity, zero ads.</h2>
|
<h2 class="section-header">Create your own free website.<br>Unlimited creativity, zero ads.</h2>
|
||||||
<p class="intro-text">
|
<p class="intro-text">
|
||||||
Neocities is a social network of <a href="/browse"><%= @sites_count.to_s.reverse.gsub(/...(?=.)/,'\&,').reverse %> web sites</a> that are bringing back the lost individual creativity of the web. We offer free web hosting and tools that allow you to create your own web site. Join us!
|
Neocities is a social network of <a href="/browse"><%= @sites_count.to_s.reverse.gsub(/...(?=.)/,'\&,').reverse %> web sites</a> that are bringing back the lost individual creativity of the web. We offer free static web hosting and tools that allow you to create your own web site. Join us!
|
||||||
</p>
|
</p>
|
||||||
<ul class="intro-List">
|
<ul class="intro-List">
|
||||||
<li class="intro-Tools">
|
<li class="intro-Tools">
|
||||||
<span class="intro-Icon"></span>
|
<span class="intro-Icon"></span>
|
||||||
<h3 class="delta">Powerful features to help you build</h3>
|
<h3 class="delta">Powerful features to help you build</h3>
|
||||||
<p class="base">
|
<p class="base">
|
||||||
We’ve made it easy to build your web site and explore other sites. Neocities features an in-browser HTML editor, custom domain support, fast site performance, easy file uploading, RSS feeds, folder support, and so much more.
|
We’ve made it easy to build your web site and explore other sites. Neocities features an in-browser HTML editor, a <a href="/cli">command line tool</a>, custom domain support, fast site performance, easy file uploading, RSS feeds, folder support, and so much more.
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="intro-Social">
|
<li class="intro-Social">
|
||||||
|
@ -235,7 +235,7 @@
|
||||||
<div class="row">
|
<div class="row">
|
||||||
<div class="col col-50">
|
<div class="col col-50">
|
||||||
<h3><i class="fa fa-wrench"></i>Developer tools</h3>
|
<h3><i class="fa fa-wrench"></i>Developer tools</h3>
|
||||||
<p>Our fast static hosting comes with a great in-browser HTML editor, easy file uploading, RSS feeds for every site, <a href="/api">APIs</a> for building developer applications, and much more!
|
<p>Our fast static hosting comes with a great in-browser HTML editor, easy file uploading, a command line tool, RSS feeds for every site, <a href="/api">APIs</a> for building developer applications, and much more!
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="col col-50">
|
<div class="col col-50">
|
||||||
|
|
Loading…
Add table
Reference in a new issue