docs: update

Author: batosai

docs/.vitepress/theme/components/HomePage.vue

@@ -1,3 +1,7 @@
+<script setup>
+import { withBase } from 'vitepress'
+</script>
+
 <template>
   <div class="home ctp-home">
     <!-- Hero -->
@@ -13,7 +17,7 @@
           Simple pipeline, zero server dependencies.
         </p>
         <div class="hero__actions">
-          <a href="/guide/getting-started" class="btn btn--primary">Get Started</a>
+          <a :href="withBase('/guide/getting-started')" class="btn btn--primary">Get Started</a>
           <a href="https://github.com/batosai/catapult" class="btn btn--secondary" target="_blank">
             <svg width="18" height="18" viewBox="0 0 24 24" fill="currentColor">
               <path
@@ -24,7 +28,7 @@
           </a>
         </div>
         <div class="hero__install">
-          <code>npm install @jrmc/catapult</code>
+          <code>npx @jrmc/catapult init</code>
         </div>
       </div>
     </section>
@@ -85,20 +89,13 @@
       <div class="quickstart__steps">
         <div class="step">
           <div class="step__number">1</div>
-          <div class="step__content">
-            <h4>Install</h4>
-            <pre><code>npm install @jrmc/catapult</code></pre>
-          </div>
-        </div>
-        <div class="step">
-          <div class="step__number">2</div>
           <div class="step__content">
             <h4>Init</h4>
-            <pre><code>cata init</code></pre>
+            <pre><code>npx @jrmc/catapult init</code></pre>
           </div>
         </div>
         <div class="step">
-          <div class="step__number">3</div>
+          <div class="step__number">2</div>
           <div class="step__content">
             <h4>Configure</h4>
             <pre><code><span class="c-keyword">import</span> { defineConfig } <span class="c-keyword">from</span> <span class="c-string">'@jrmc/catapult'</span>
@@ -115,10 +112,10 @@
           </div>
         </div>
         <div class="step">
-          <div class="step__number">4</div>
+          <div class="step__number">3</div>
           <div class="step__content">
             <h4>Deploy</h4>
-            <pre><code>cata deploy</code></pre>
+            <pre><code>npx cata deploy</code></pre>
           </div>
         </div>
       </div>

docs/guide/getting-started.md

@@ -2,25 +2,21 @@
 
 ## Installation
 
-```bash
-npm install @jrmc/catapult
-```
-
-Once installed, the `cata` CLI is available:
+Run the following command at the root of your project:
 
 ```bash
-cata deploy
+npx @jrmc/catapult init
 ```
 
-## Usage
-
-Generate a `deploy.ts` file at the root of your project:
+This creates a `deploy.ts` configuration file and installs `@jrmc/catapult` as a dev dependency. Once installed, the `cata` CLI is available:
 
 ```bash
-cata init
+npx cata deploy
 ```
 
-Or create it manually:
+## Configuration
+
+Edit the generated `deploy.ts` file, or create it manually:
 
 ```typescript
 import { defineConfig } from '@jrmc/catapult'
@@ -39,7 +35,10 @@ await defineConfig({
       name: 'staging',
       ssh: 'deploy@staging.example.com',
       deployPath: '/home/deploy/staging/myapp',
-      branch: 'develop',
+      branch: {
+        name: 'develop',
+        ask: true,
+      },
       healthcheckUrl: 'http://127.0.0.1:3333/health',
     },
     {
@@ -59,37 +58,37 @@ await defineConfig({
 
 ```bash
 # Show the current version
-cata version
+npx cata version
 
 # Create a deploy.ts configuration file
-cata init
-
-# Deploy
-cata deploy
+npx cata init
 
 # Initial server setup (create directories)
-cata deploy:setup
+npx cata deploy:setup
+
+# Deploy
+npx cata deploy
 
 # Rollback to the previous release
-cata rollback
+npx cata rollback
 
 # Server status
-cata status
+npx cata status
 
 # List releases
-cata list:releases
+npx cata list:releases
 
 # List registered tasks and the current pipeline
-cata list:tasks
+npx cata list:tasks
 
 # Run a specific task on servers
-cata task <task-name>
+npx cata task <task-name>
 
 # Target a specific host
-cata deploy --host staging
+npx cata deploy --host staging
 
 # Override the branch to deploy
-cata deploy --branch feature/my-feature
+npx cata deploy --branch feature/my-feature
 ```
 
 ## Branch
@@ -125,7 +124,7 @@ hosts: [
 You can also override the branch for all hosts at deploy time:
 
 ```bash
-cata deploy --branch feature/my-feature
+npx cata deploy --branch feature/my-feature
 ```
 
 ## Server structure
@@ -171,7 +170,7 @@ hosts: [
 Deployment runs sequentially on each host. To target a single host:
 
 ```bash
-cata deploy --host staging
+npx cata deploy --host staging
 ```
 
 ## Automatic rollback

docs/guide/pipeline.md

@@ -129,8 +129,8 @@ after('deploy:healthcheck', 'notify')
 Any registered task — whether built-in, added by a recipe, or defined in `deploy.ts` — can be run directly from the terminal.
 
 ```bash
-cata task adonisjs:migrate
-cata task cache:clear --host staging
+npx cata task adonisjs:migrate
+npx cata task cache:clear --host staging
 ```
 
 ## Template variables