{"_path":"/components/avanda-cli/guide","_draft":false,"_partial":false,"_empty":false,"title":"CLI Guide","description":"Here are some guides for running commands with Avanda CLI:","excerpt":{"type":"root","children":[{"type":"element","tag":"h1","props":{"id":"cli-guide"},"children":[{"type":"text","value":"CLI Guide"}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Here are some guides for running commands with Avanda CLI:"}]},{"type":"element","tag":"h2","props":{"id":"commands"},"children":[{"type":"text","value":"Commands"}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Here are the list of some basic commands"}]},{"type":"element","tag":"blockquote","props":{},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Don't know what asset-types, actions are? Check "},{"type":"element","tag":"a","props":{"href":"#command-arguments"},"children":[{"type":"text","value":"Command Arguments"}]}]}]},{"type":"element","tag":"table","props":{},"children":[{"type":"element","tag":"thead","props":{},"children":[{"type":"element","tag":"tr","props":{},"children":[{"type":"element","tag":"th","props":{"align":null},"children":[{"type":"text","value":"Command"}]},{"type":"element","tag":"th","props":{"align":null},"children":[{"type":"text","value":"Description"}]},{"type":"element","tag":"th","props":{"align":null},"children":[{"type":"text","value":"Usage"}]}]}]},{"type":"element","tag":"tbody","props":{},"children":[{"type":"element","tag":"tr","props":{},"children":[{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"create"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"Automatically generates assets, asset types includes: "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"controller"}]},{"type":"text","value":", "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"middleware"}]},{"type":"text","value":", "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"seeder"}]},{"type":"text","value":"..etc"}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"$yarn avanda create <asset-type> <option> <name>"}]}]}]},{"type":"element","tag":"tr","props":{},"children":[{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"app"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"App migration command, executes actions, includes: "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"install"}]},{"type":"text","value":", "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"seed"}]},{"type":"text","value":" ...etc"}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"$ yarn avanda app <action> <option> <file-name>"}]}]}]},{"type":"element","tag":"tr","props":{},"children":[{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"init"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"Create a new avanda project"}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"$ yarn avanda init <project-name>"}]}]}]},{"type":"element","tag":"tr","props":{},"children":[{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"serve"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"Serves your project for development mode with compiling on changes made"}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"$ yarn avanda serve"}]}]}]}]}]},{"type":"element","tag":"h3","props":{"id":"command-arguments"},"children":[{"type":"text","value":"Command Arguments"}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"CLI commands accepts some arguments you can tag along to give more intructions to the commands.\nComand Arguments are broken into two parts which are options and Actions"}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Here are some of the command arguments available:"}]},{"type":"element","tag":"h3","props":{"id":"options"},"children":[{"type":"text","value":"Options"}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Here are some of the options available:"}]},{"type":"element","tag":"table","props":{},"children":[{"type":"element","tag":"thead","props":{},"children":[{"type":"element","tag":"tr","props":{},"children":[{"type":"element","tag":"th","props":{"align":null},"children":[{"type":"text","value":"Options"}]},{"type":"element","tag":"th","props":{"align":null},"children":[{"type":"text","value":"Description"}]},{"type":"element","tag":"th","props":{"align":null},"children":[{"type":"text","value":"Usage"}]}]}]},{"type":"element","tag":"tbody","props":{},"children":[{"type":"element","tag":"tr","props":{},"children":[{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"-t"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"Refers to table or "},{"type":"element","tag":"a","props":{"href":"/guide/model"},"children":[{"type":"text","value":"Model"}]},{"type":"text","value":" name"}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"$ yarn avanda app install -t <model-name>"}]}]}]},{"type":"element","tag":"tr","props":{},"children":[{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"-n"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"Refers to asset name"}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"$ yarn avanda create Model -n <model-name>"}]}]}]},{"type":"element","tag":"tr","props":{},"children":[{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"-a"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"Mainly used with "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"create"}]},{"type":"text","value":" command to create all necessary assets"}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"$ yarn avanda create -a <asset-name>"}]}]}]}]}]},{"type":"element","tag":"h3","props":{"id":"actions"},"children":[{"type":"text","value":"Actions"}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"These are mostly paired along the "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"app"}]},{"type":"text","value":" command, they are mainly used to interact with your database"}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Here are some of the actions available:"}]},{"type":"element","tag":"table","props":{},"children":[{"type":"element","tag":"thead","props":{},"children":[{"type":"element","tag":"tr","props":{},"children":[{"type":"element","tag":"th","props":{"align":null},"children":[{"type":"text","value":"Actions"}]},{"type":"element","tag":"th","props":{"align":null},"children":[{"type":"text","value":"Description"}]},{"type":"element","tag":"th","props":{"align":null},"children":[{"type":"text","value":"Usage"}]}]}]},{"type":"element","tag":"tbody","props":{},"children":[{"type":"element","tag":"tr","props":{},"children":[{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"install"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"This is used to install your "},{"type":"element","tag":"a","props":{"href":"/guide/model"},"children":[{"type":"text","value":"Model"}]},{"type":"text","value":" Schema to a table, accepts option of table name "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"-t"}]},{"type":"text","value":" and name of your model"}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"$ yarn avanda app install -t <model-name>"}]}]}]},{"type":"element","tag":"tr","props":{},"children":[{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"seed"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"Seeds or adds provided data to the Specified table, accepts option of table name "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"-t"}]},{"type":"text","value":" and model name"}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"$ yarn avanda app seed -t <model-name>"}]}]}]}]}]}]},"body":{"type":"root","children":[{"type":"element","tag":"h1","props":{"id":"cli-guide"},"children":[{"type":"text","value":"CLI Guide"}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Here are some guides for running commands with Avanda CLI:"}]},{"type":"element","tag":"h2","props":{"id":"commands"},"children":[{"type":"text","value":"Commands"}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Here are the list of some basic commands"}]},{"type":"element","tag":"blockquote","props":{},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Don't know what asset-types, actions are? Check "},{"type":"element","tag":"a","props":{"href":"#command-arguments"},"children":[{"type":"text","value":"Command Arguments"}]}]}]},{"type":"element","tag":"table","props":{},"children":[{"type":"element","tag":"thead","props":{},"children":[{"type":"element","tag":"tr","props":{},"children":[{"type":"element","tag":"th","props":{"align":null},"children":[{"type":"text","value":"Command"}]},{"type":"element","tag":"th","props":{"align":null},"children":[{"type":"text","value":"Description"}]},{"type":"element","tag":"th","props":{"align":null},"children":[{"type":"text","value":"Usage"}]}]}]},{"type":"element","tag":"tbody","props":{},"children":[{"type":"element","tag":"tr","props":{},"children":[{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"create"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"Automatically generates assets, asset types includes: "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"controller"}]},{"type":"text","value":", "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"middleware"}]},{"type":"text","value":", "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"seeder"}]},{"type":"text","value":"..etc"}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"$yarn avanda create <asset-type> <option> <name>"}]}]}]},{"type":"element","tag":"tr","props":{},"children":[{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"app"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"App migration command, executes actions, includes: "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"install"}]},{"type":"text","value":", "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"seed"}]},{"type":"text","value":" ...etc"}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"$ yarn avanda app <action> <option> <file-name>"}]}]}]},{"type":"element","tag":"tr","props":{},"children":[{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"init"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"Create a new avanda project"}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"$ yarn avanda init <project-name>"}]}]}]},{"type":"element","tag":"tr","props":{},"children":[{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"serve"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"Serves your project for development mode with compiling on changes made"}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"$ yarn avanda serve"}]}]}]}]}]},{"type":"element","tag":"h3","props":{"id":"command-arguments"},"children":[{"type":"text","value":"Command Arguments"}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"CLI commands accepts some arguments you can tag along to give more intructions to the commands.\nComand Arguments are broken into two parts which are options and Actions"}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Here are some of the command arguments available:"}]},{"type":"element","tag":"h3","props":{"id":"options"},"children":[{"type":"text","value":"Options"}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Here are some of the options available:"}]},{"type":"element","tag":"table","props":{},"children":[{"type":"element","tag":"thead","props":{},"children":[{"type":"element","tag":"tr","props":{},"children":[{"type":"element","tag":"th","props":{"align":null},"children":[{"type":"text","value":"Options"}]},{"type":"element","tag":"th","props":{"align":null},"children":[{"type":"text","value":"Description"}]},{"type":"element","tag":"th","props":{"align":null},"children":[{"type":"text","value":"Usage"}]}]}]},{"type":"element","tag":"tbody","props":{},"children":[{"type":"element","tag":"tr","props":{},"children":[{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"-t"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"Refers to table or "},{"type":"element","tag":"a","props":{"href":"/guide/model"},"children":[{"type":"text","value":"Model"}]},{"type":"text","value":" name"}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"$ yarn avanda app install -t <model-name>"}]}]}]},{"type":"element","tag":"tr","props":{},"children":[{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"-n"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"Refers to asset name"}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"$ yarn avanda create Model -n <model-name>"}]}]}]},{"type":"element","tag":"tr","props":{},"children":[{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"-a"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"Mainly used with "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"create"}]},{"type":"text","value":" command to create all necessary assets"}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"$ yarn avanda create -a <asset-name>"}]}]}]}]}]},{"type":"element","tag":"h3","props":{"id":"actions"},"children":[{"type":"text","value":"Actions"}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"These are mostly paired along the "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"app"}]},{"type":"text","value":" command, they are mainly used to interact with your database"}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Here are some of the actions available:"}]},{"type":"element","tag":"table","props":{},"children":[{"type":"element","tag":"thead","props":{},"children":[{"type":"element","tag":"tr","props":{},"children":[{"type":"element","tag":"th","props":{"align":null},"children":[{"type":"text","value":"Actions"}]},{"type":"element","tag":"th","props":{"align":null},"children":[{"type":"text","value":"Description"}]},{"type":"element","tag":"th","props":{"align":null},"children":[{"type":"text","value":"Usage"}]}]}]},{"type":"element","tag":"tbody","props":{},"children":[{"type":"element","tag":"tr","props":{},"children":[{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"install"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"This is used to install your "},{"type":"element","tag":"a","props":{"href":"/guide/model"},"children":[{"type":"text","value":"Model"}]},{"type":"text","value":" Schema to a table, accepts option of table name "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"-t"}]},{"type":"text","value":" and name of your model"}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"$ yarn avanda app install -t <model-name>"}]}]}]},{"type":"element","tag":"tr","props":{},"children":[{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"seed"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"Seeds or adds provided data to the Specified table, accepts option of table name "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"-t"}]},{"type":"text","value":" and model name"}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"$ yarn avanda app seed -t <model-name>"}]}]}]}]}]}],"toc":{"title":"","searchDepth":3,"depth":3,"links":[{"id":"commands","depth":2,"text":"Commands","children":[{"id":"command-arguments","depth":3,"text":"Command Arguments"},{"id":"options","depth":3,"text":"Options"},{"id":"actions","depth":3,"text":"Actions"}]}]}},"_type":"markdown","_id":"content:2.components:1.avanda-cli:2.guide.md","_source":"content","_file":"2.components/1.avanda-cli/2.guide.md","_extension":"md"}