Voltは、プロジェクトの管理やデータの操作に関する様々なコマンドを提供しています。
新しいプロジェクトを作成する場合には、volt new project_name
を実行します。newコマンドは基本的なアプリケーションの構成を構築しますので、新規プロジェクトを作成する場合にはnewコマンドを利用することを推奨します。
注意: volt newは、実行時にbundle exec
をつけない唯一のコマンドです。その他のコマンドはすべて bundle exec
をつけて実行する必要があります。
generateコマンドは、スタブのコードを生成するためのコマンドです。
bundle exec volt generate model NAME COMPONENT
NAME には生成したいモデルの名前を指定します。モデル名は単数形で指定してください。もし COMPONENT が指定されない場合は、main
コンポーネントが指定されたものとします。
例:
bundle exec volt generate model item
bundle exec volt generate component NAME
コンポーネントジェネレーターが app
以下にコンポーネントを生成します。
例:
bundle exec volt generate component blog
bundle exec volt generate gem NAME
Gemはコンポーネントのgemのためのファイルを生成します。コンポーネントのgemは、複数のプロジェクトにまたがってコンポーネントを再利用することを容易にします。
bundle exec volt generate view NAME COMPONENT
'view' generates the files for a Volt view. もし、対応するモデルコントローラーが存在しない場合は、同時に生成を行います。
オプションでコンポーネントを指定することも可能ですが、デフォルトではmain
が指定されたものとします。
bundle exec volt generate task NAME COMPONENT
'task' generates the files for a Volt task. オプションでコンポーネントを指定することも可能ですが、デフォルトではmain
が指定されたものとします。
bundle exec volt generate controller NAME COMPONENT
'model controller' generates the files for a Volt model controller. オプションでコンポーネントを指定することも可能ですが、デフォルトではmain
が指定されたものとします。
bundle exec volt generate http_controller NAME COMPONENT
'http_controller' generates the files for a Volt HTTP Controller. オプションでコンポーネントを指定することも可能ですが、デフォルトではmain
が指定されたものとします。
bundle exec volt server
サーバーを起動します。デフォルトのポートは3000です。
オプション:
TODO: finish docs for precompile
bundle exec volt runner path/to/file.rb
runnerは、Voltのenvironmentでコードを実行するため使用します。引数には、実行したいRubyファイルのパスを指定してください。
TODO:...