Skip to content
This repository
Browse code

Clean up content

The reason for removing the command line output is to reduce content which can be retrieved via CLI.
This way we can make the documentation more DRY because changes on the CLI don't have to be corrected in the docs.
  • Loading branch information...
commit cd256a83265cc891546deaad67058ab75137c3d2 1 parent 04e7de8
Christian Trabold authored February 05, 2013

Showing 1 changed file with 45 additions and 59 deletions. Show diff stats Hide diff stats

  1. 104  doc/running.md
104  doc/running.md
Source Rendered
... ...
@@ -1,10 +1,8 @@
1  
-# Running veewee
  1
+# Running veewee commands
2 2
 
3  
-## Calling veewee
  3
+The first way to call veewee is through the `veewee` cli command.
4 4
 
5  
-### Using veewee cli
6  
-
7  
-The first way to call veewee is through the `veewee` cli command:
  5
+Simply type `veewee` to get a list for the basic commands:
8 6
 
9 7
     $ veewee
10 8
     Tasks:
@@ -14,78 +12,66 @@ The first way to call veewee is through the `veewee` cli command:
14 12
       veewee vbox         # Subcommand for virtualbox
15 13
       veewee version      # Prints the Veewee version information
16 14
 
17  
-### Using veewee as a vagrant plugin
  15
+Each of these commands provides more details if you execute them.
18 16
 
19  
-The second way is to use it a vagrant plugin. Veewee registeres itself as a subcommand 'basebox'
  17
+The following command gives you a list of all available subcommands:
20 18
 
21  
-    $ vagrant basebox
22  
-    Usage: vagrant basebox <command> [<args>]
  19
+    veewee vbox
23 20
 
24  
-    Available subcommands:
25  
-         build
26  
-         define
27  
-         destroy
28  
-         export
29  
-         halt
30  
-         list
31  
-         ostypes
32  
-         ssh
33  
-         templates
34  
-         undefine
35  
-         up
  21
+Change `vbox` to `fusion` or `kvm` if you want to use a different provider.
36 22
 
37  
-    For help on any individual command run `vagrant basebox COMMAND -h`
38 23
 
  24
+## Typical Usage
39 25
 
40  
-## Available commands
  26
+A typical workflow to build a new basebox with veewee would be:
41 27
 
42  
-The following command are available: change the vbox to fusion or kvm if you want to use a different <provider>
  28
+    1. Define a box definition from a template
  29
+    2. Build the box from an ISO file
  30
+    3. Export the box e.g. for distribution
43 31
 
44  
-    Tasks:
45  
-      veewee vbox build [BOX_NAME]             # Build box
46  
-      veewee vbox define [BOXNAME] [TEMPLATE]  # Define a new basebox starting fr...
47  
-      veewee vbox destroy [BOXNAME]            # Destroys the basebox that was built
48  
-      veewee vbox halt [BOXNAME]               # Activates a shutdown on the basebox
49  
-      veewee vbox help [COMMAND]               # Describe subcommands or one spec...
50  
-      veewee vbox list                         # Lists all defined boxes
51  
-      veewee vbox ostypes                      # List the available Operating Sys...
52  
-      veewee vbox ssh [BOXNAME] [COMMAND]      # Shows SSH information
53  
-      veewee vbox templates                    # List the currently available tem...
54  
-      veewee vbox undefine [BOXNAME]           # Removes the definition of a base...
55  
-      veewee vbox up [BOXNAME]                 # Starts a Box
56  
-      veewee vbox validate [NAME]              # Validates a box against vagrant ...
  32
+The following commands take care of this:
  33
+
  34
+    $ veewee vbox define 'mybuntubox' 'ubuntu-10.12-amd64'
  35
+    $ veewee vbox build 'mybuntubox'
  36
+    $ veewee vbox export 'mybuntubox'
  37
+
  38
+The export format depends on the provider. You can currently choose from these providers:
57 39
 
  40
+- `fusion`: exports to an '.ova' file
  41
+- `kvm`: export to a raw '.img' file
  42
+- `vbox`: exports to a '.box' format (e.g. for use in vagrant)
58 43
 
59  
-## Non-Vagrant usage
  44
+If you want to tweak things on the box you can login to the box with this command:
60 45
 
61  
-A typical cycle would be:
  46
+    $ veewee vbox ssh 'mybuntubox'
62 47
 
63  
-    $ veewee vbox define 'mybuntu' 'ubuntu-10.10-amd64'
64  
-    $ veewee vbox build 'myubuntu'
65  
-    $ veewee vbox ssh 'myubuntu'
66  
-    $ veewee vbox halt 'myubuntu'
67  
-    $ veewee vbox up 'myubuntu'
68  
-    $ veewee vbox export 'myubuntu'
  48
+PRO TIP: Be aware that every manual change on the box is considered harmful.
  49
+Have a look at [customize.md](customize.md) to see how you can customize the box in a more 'reproducible' way.
69 50
 
70 51
 
71  
-## Vagrant usage
  52
+## Using veewee as a Vagrant Plugin
  53
+
  54
+You can also use veewee as a [vagrant plugin](http://docs.vagrantup.com/v1/docs/plugins.html).
  55
+
  56
+Veewee introduces the subcommand `basebox` on top of the `vagrant` command:
  57
+
  58
+    $ vagrant basebox
  59
+    Usage: vagrant basebox <command> [<args>]
  60
+
  61
+This allows you to use the 'vagrant' command style, which may feel more natural
  62
+if you are already working with vagrant.
72 63
 
73  
-A typical cycle would be:
74 64
 
75  
-    $ vagrant basebox define 'myubuntu' 'ubuntu-10.10-amd64'
76  
-    $ vagrant basebox build 'myubuntu'
77  
-    $ vagrant basebox export 'myubuntu'
  65
+### Typical Vagrant Usage
78 66
 
79  
-    $ vagrant basebox add 'myubuntu' 'myubuntu.box'
80  
-    $ vagrant init 'mybuntu'
81  
-    $ vagrant up
82  
-    $ vagrant ssh
  67
+A typical workflow would be:
83 68
 
  69
+    $ vagrant basebox define 'mybuntubox' 'ubuntu-10.12-amd64'
  70
+    $ vagrant basebox build 'mybuntubox'
  71
+    $ vagrant basebox export 'mybuntubox'
84 72
 
85  
-## Exporting a vm
  73
+Now you can import the generated '.box' file to the vagrant box repository:
86 74
 
87  
-The export format depends on the provider:
  75
+    $ vagrant basebox add 'mybuntubox' 'mybuntubox.box'
88 76
 
89  
-- fusion : exports to an 'ova' file
90  
-- kvm : export to a raw '.img' file
91  
-- vbox: exports to a '.box' format (for use in vagrant)
  77
+See "[Use it in vagrant](vagrant.md)" for more details.

0 notes on commit cd256a8

Please sign in to comment.
Something went wrong with that request. Please try again.