Skip to content

Commit a25a2b1

Browse files
scribuscribu
committed
add initial version; generated via github
0 parents  commit a25a2b1

5 files changed

Lines changed: 503 additions & 0 deletions

File tree

‎CNAME‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
wp-cli.org

‎images/bkg.png‎

4.16 KB
Loading

‎images/blacktocat.png‎

1.24 KB
Loading

‎index.html‎

Lines changed: 255 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,255 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<meta charset='utf-8'>
5+
<meta http-equiv="X-UA-Compatible" content="chrome=1">
6+
7+
<link rel="stylesheet" type="text/css" href="stylesheets/stylesheet.css" media="screen" />
8+
<link rel="stylesheet" type="text/css" href="stylesheets/pygment_trac.css" media="screen" />
9+
<link rel="stylesheet" type="text/css" href="stylesheets/print.css" media="print" />
10+
11+
<title>wp-cli by wp-cli</title>
12+
</head>
13+
14+
<body>
15+
16+
<header>
17+
<div class="container">
18+
<h1>wp-cli</h1>
19+
<h2>A command line interface for WordPress</h2>
20+
21+
<section id="downloads">
22+
<a href="https://github.com/wp-cli/wp-cli/zipball/master" class="btn">Download as .zip</a>
23+
<a href="https://github.com/wp-cli/wp-cli/tarball/master" class="btn">Download as .tar.gz</a>
24+
<a href="https://github.com/wp-cli/wp-cli" class="btn btn-github"><span class="icon"></span>View on GitHub</a>
25+
</section>
26+
</div>
27+
</header>
28+
29+
<div class="container">
30+
<section id="main_content">
31+
<h2>What is wp-cli?</h2>
32+
33+
<p>wp-cli is a set of command-line tools for managing WordPress installations. You can update plugins, set up multisite installs, update posts and much more.</p>
34+
35+
<p>Visit the <a href="https://github.com/wp-cli/wp-cli/wiki">wiki</a> for more information.</p>
36+
37+
<h1>Requirements</h1>
38+
39+
<ul>
40+
<li>PHP &gt;= 5.3</li>
41+
<li>WP &gt;= 3.3</li>
42+
</ul><h1>Installing</h1>
43+
44+
<p><strong>Via PEAR:</strong></p>
45+
46+
<div class="highlight"><pre>sudo pear config-set auto_discover 1
47+
sudo pear install wp-cli.github.com/pear/wpcli
48+
</pre></div>
49+
50+
<p><strong>Via GIT:</strong></p>
51+
52+
<div class="highlight"><pre>git clone --recursive git://github.com/wp-cli/wp-cli.git ~/git/wp-cli
53+
<span class="nb">cd</span> ~/git/wp-cli
54+
sudo utils/dev-build
55+
</pre></div>
56+
57+
<p>You can replace <code>~/git/wp-cli</code> with whatever you want.</p>
58+
59+
<h2>MAMP, XAMP, etc.</h2>
60+
61+
<p>If the <code>php</code> command is not available, you can try finding an appropriate binary:</p>
62+
63+
<div class="highlight"><pre>./utils/find-php
64+
</pre></div>
65+
66+
<p>Then, create an environment variable called <code>WP_CLI_PHP</code> with the path found by <code>find-php</code>.</p>
67+
68+
<p>In a UNIX environment, you would do this by adding the following line to your <code>.bashrc</code> file:</p>
69+
70+
<div class="highlight"><pre><span class="nv">WP_CLI_PHP</span><span class="o">=</span>/path/to/php-binary
71+
</pre></div>
72+
73+
<h1>Using</h1>
74+
75+
<p>Go into a WordPress root folder:</p>
76+
77+
<pre><code>cd /var/www/wp/
78+
</code></pre>
79+
80+
<p>Typing <code>wp help</code> should show you an output similar to this:</p>
81+
82+
<pre><code>Example usage:
83+
wp google-sitemap [build|help] ...
84+
wp core [update|help] ...
85+
wp home [help] ...
86+
wp option [add|update|delete|get|help] ...
87+
wp plugin [status|activate|deactivate|install|delete|update|help] ...
88+
wp theme [status|details|activate|help] ...
89+
</code></pre>
90+
91+
<p>So this tells us which commands are installed: eg. google-sitemap, core, home, ...
92+
Between brackets you can see their sub commands. </p>
93+
94+
<p>Let's for example try to install the hello dolly plugin from wordpress.org:</p>
95+
96+
<pre><code>wp plugin install hello-dolly
97+
</code></pre>
98+
99+
<p>Output:</p>
100+
101+
<pre><code>Installing Hello Dolly (1.5)
102+
103+
Downloading install package from http://downloads.WordPress.org/plugin/hello-dolly.1.5.zip ...
104+
Unpacking the package ...
105+
Installing the plugin ...
106+
107+
Success: The plugin is successfully installed
108+
</code></pre>
109+
110+
<h2>Multisite</h2>
111+
112+
<p>On a multisite installation, you need to pass a --blog parameter, so that WP knows which site it's supposed to be operating on:</p>
113+
114+
<pre><code>wp theme status --blog=localhost/wp/test
115+
</code></pre>
116+
117+
<p>If you have a subdomain installation, it would look like this:</p>
118+
119+
<pre><code>wp theme status --blog=test.example.com
120+
</code></pre>
121+
122+
<p>If you're usually working on the same site most of the time, you can put the url of that site in a file called 'wp-cli-blog' in your root WP dir:</p>
123+
124+
<pre><code>echo 'test.example.com' &gt; wp-cli-blog
125+
</code></pre>
126+
127+
<p>Then, you can call <code>wp</code> without the --blog parameter again:</p>
128+
129+
<pre><code>wp theme status
130+
</code></pre>
131+
132+
<h1>Adding commands</h1>
133+
134+
<p>Adding commands to wp-cli is very easy. You can even add them from within your own plugin.
135+
You can find more information about adding commands in the <a href="https://github.com/wp-cli/wp-cli/wiki/Commands-Cookbook">Commands Cookbook</a> on our Wiki.</p>
136+
137+
<p><strong>Please share the commands you make, issue a pull request to get them included in wp-cli by default.</strong></p>
138+
139+
<h1>Changelog</h1>
140+
141+
<p><strong>0.6</strong></p>
142+
143+
<ul>
144+
<li>added <code>wp post</code> and <code>wp post-meta</code>
145+
</li>
146+
<li>added <code>wp user-meta</code>
147+
</li>
148+
<li>added <code>wp blog create</code>
149+
</li>
150+
<li>added <code>wp export</code>
151+
</li>
152+
<li>added <code>wp transient</code>
153+
</li>
154+
<li>added <code>wp db optimize</code> and <code>wp db repair</code>
155+
</li>
156+
<li>added <code>wp db create</code>, <code>wp db drop</code> and <code>wp db reset</code>
157+
</li>
158+
<li>added <code>wp db import</code>
159+
</li>
160+
<li>added <code>wp theme install</code> and <code>wp theme update</code>
161+
</li>
162+
<li>added <code>wp core install_network</code>
163+
</li>
164+
<li>added <code>wp core update_db</code>
165+
</li>
166+
<li>added <code>--json</code> option to several subcommands</li>
167+
<li>added <code>--network</code> option to <code>wp plugin activate</code>
168+
</li>
169+
<li>added <code>--require</code> global parameter</li>
170+
<li>fixed <code>wp plugin update</code>
171+
</li>
172+
<li>fixed "out of memory" error</li>
173+
<li>misc bugfixes and optimizations</li>
174+
<li>man pages (not in PEAR package)</li>
175+
</ul><p><strong>0.5</strong></p>
176+
177+
<ul>
178+
<li>added <code>wp user</code>
179+
</li>
180+
<li>added <code>wp core download</code>
181+
</li>
182+
<li>added <code>wp core config</code>
183+
</li>
184+
<li>added <code>wp plugin update --all</code>
185+
</li>
186+
<li>added <code>wp theme update</code>
187+
</li>
188+
<li>added <code>wp db import</code>
189+
</li>
190+
<li>added <code>--url</code> <code>--path</code> and <code>--user</code> global parameters</li>
191+
<li>various bugfixes</li>
192+
</ul><p><strong>0.4</strong></p>
193+
194+
<ul>
195+
<li>added <code>wp eval</code> and <code>wp eval-file</code>
196+
</li>
197+
<li>added <code>wp export</code>
198+
</li>
199+
<li>added <code>wp core install</code>
200+
</li>
201+
<li>fixed <code>wp core update</code>
202+
</li>
203+
<li>added <code>--dev</code> flag to <code>wp plugin install</code>
204+
</li>
205+
<li>added <code>wp plugin uninstall</code>
206+
</li>
207+
<li>fixed <code>wp plugin install</code> and <code>wp plugin update</code>
208+
</li>
209+
</ul><p><strong>0.3</strong></p>
210+
211+
<ul>
212+
<li>added <code>wp sql</code>
213+
</li>
214+
<li>improved <code>wp option</code>
215+
</li>
216+
<li>pear installer</li>
217+
</ul><p><strong>0.2</strong></p>
218+
219+
<ul>
220+
<li>added multisite support</li>
221+
<li>improved <code>wp plugin</code> and <code>wp theme</code>
222+
</li>
223+
<li>added <code>wp generate</code>
224+
</li>
225+
<li>added <code>wp core version</code>
226+
</li>
227+
<li>added <code>wp --version</code>
228+
</li>
229+
<li>added bash completion script</li>
230+
</ul><p><strong>0.1</strong></p>
231+
232+
<ul>
233+
<li>initial release</li>
234+
</ul><h2>Contributors</h2>
235+
236+
<ul>
237+
<li><a href="https://github.com/wp-cli/wp-cli/contributors">Contributor list</a></li>
238+
<li><a href="https://github.com/wp-cli/wp-cli/wiki/Commands-Cookbook">Contributor guide</a></li>
239+
</ul>
240+
</section>
241+
</div>
242+
243+
<script type="text/javascript">
244+
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
245+
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
246+
</script>
247+
<script type="text/javascript">
248+
try {
249+
var pageTracker = _gat._getTracker("UA-962663-21");
250+
pageTracker._trackPageview();
251+
} catch(err) {}
252+
</script>
253+
254+
</body>
255+
</html>

0 commit comments

Comments
 (0)