1111 < link rel ="canonical " href ="https://explodinglabs.com/iko/commands/ ">
1212
1313
14- < link rel ="prev " href ="../usage / ">
14+ < link rel ="prev " href ="../gettingstarted / ">
1515
1616
1717 < link rel ="next " href ="../scripting/ ">
288288
289289
290290 < li class ="md-nav__item ">
291- < a href ="../installation / " class ="md-nav__link ">
291+ < a href ="../gettingstarted / " class ="md-nav__link ">
292292
293293
294294
295295 < span class ="md-ellipsis ">
296- Installation
297-
298- </ span >
299-
300-
301- </ a >
302- </ li >
303-
304-
305-
306-
307-
308-
309-
310-
311-
312- < li class ="md-nav__item ">
313- < a href ="../usage/ " class ="md-nav__link ">
314-
315-
316-
317- < span class ="md-ellipsis ">
318- Usage
296+ Getting Started
319297
320298 </ span >
321299
10251003
10261004
10271005< h1 id ="commands "> Commands</ h1 >
1028- < p > Iko provides a command-line interface for generating and managing Sqitch-based
1029- migrations.</ p >
1030- < p > This page is a reference for all available commands.</ p >
1006+ < p > This page documents all available commands provided by Iko.</ p >
1007+ < p > Iko commands are used to define database migrations. They can be run
1008+ interactively via the command line, or embedded inside reusable Bash scripts.</ p >
1009+ < p > Most commands generate a deploy/revert/verify triple of Sqitch migrations using
1010+ built-in templates. For commands that aren't covered, you can always fall back
1011+ to ad-hoc < code > add</ code > migrations.</ p >
1012+ < p > For an overview of how scripting works, see < a href ="../scripting/ "> Scripting
1013+ Migrations</ a > .</ p >
10311014< h2 id ="sqitch-commands "> Sqitch commands</ h2 >
10321015< p > Iko aliases all of < a href ="https://sqitch.org/docs/manual/ "> Sqitch's commands</ a > .</ p >
10331016< p > For example, < code > sqitch check</ code > becomes < code > iko check</ code > .</ p >
10341017< p > You can also access < code > sqitch</ code > directly, for example:</ p >
10351018< div class ="highlight "> < pre > < span > </ span > < code > iko< span class ="w "> </ span > sqitch< span class ="w "> </ span > --version
10361019</ code > </ pre > </ div >
1037- < p > When scripting, the < code > iko</ code > part is left out. For example, < code > iko create_schema api</ code > becomes simply < code > create_schema api</ code > . In this document the < code > iko</ code > command is
1038- left out.</ p >
10391020< h2 id ="ad-hoc-migrations "> Ad-hoc migrations</ h2 >
10401021< blockquote >
10411022< p > 📖 Refer to < a href ="https://sqitch.org/docs/manual/sqitch-add/ "> sqitch-add</ a > .</ p >
@@ -1283,7 +1264,7 @@ <h4>Example</h4>
12831264 < nav class ="md-footer__inner md-grid " aria-label ="Footer " >
12841265
12851266
1286- < a href ="../usage / " class ="md-footer__link md-footer__link--prev " aria-label ="Previous: Usage ">
1267+ < a href ="../gettingstarted / " class ="md-footer__link md-footer__link--prev " aria-label ="Previous: Getting Started ">
12871268 < div class ="md-footer__button md-icon ">
12881269
12891270 < svg xmlns ="http://www.w3.org/2000/svg " viewBox ="0 0 24 24 "> < path d ="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z "/> </ svg >
@@ -1293,7 +1274,7 @@ <h4>Example</h4>
12931274 Previous
12941275 </ span >
12951276 < div class ="md-ellipsis ">
1296- Usage
1277+ Getting Started
12971278 </ div >
12981279 </ div >
12991280 </ a >
0 commit comments