@rharkor/caching-for-turbo 2.0.0 → 2.1.1

package/.env.example

@@ -7,4 +7,9 @@ S3_PREFIX=turbogha/
 PROVIDER=s3
 MAX_AGE=1d
 MAX_FILES=100
-MAX_SIZE=100mb
+MAX_SIZE=100mb
+
+TURBOGHA_PORT=41230
+TURBO_API=http://localhost:41230
+TURBO_TOKEN=turbogha
+TURBO_TEAM=turbogha

package/README.md

@@ -55,7 +55,7 @@ the following step **before** you run `turbo build`:
 
 ```yaml
 - name: Cache for Turbo
-  uses: rharkor/caching-for-turbo@v2.0.0
+  uses: rharkor/caching-for-turbo@v2.1.0
 ```
 
 This GitHub Action facilitates:
@@ -69,16 +69,16 @@ This GitHub Action facilitates:
 
 ## Local Development
 
-You can also use this package as a devDependency to run the cache server locally
-during development. This allows you to use the same caching infrastructure
-(including S3) that you use in CI.
+You can also use this package as a global dependency to run the cache server
+locally during development. This allows you to use the same caching
+infrastructure (including S3) that you use in CI.
 
 ### Installation
 
-Add this package as a devDependency to your project:
+Add this package as a global dependency:
 
 ```bash
-npm install --save-dev @rharkor/caching-for-turbo
+npm install -g @rharkor/caching-for-turbo
 ```
 
 ### Usage
@@ -88,22 +88,22 @@ server:
 
 ```bash
 # Start the server in background mode (recommended for development)
-npx turbogha
+turbogha
 
 # Or run the server in foreground mode
-npx turbogha --server
+turbogha --server
 ```
 
 To stop the server, you can use the following command:
 
 ```bash
-curl -X DELETE http://localhost:41230/shutdown
+turbogha --kill
 ```
 
 To ping the server, you can use the following command:
 
 ```bash
-npx turbogha --ping
+turbogha --ping
 ```
 
 ### Environment Configuration
@@ -140,7 +140,6 @@ export TURBO_TEAM=turbogha
 turbo build
 ```
 
-_**Note:** Store the environment variables in a .env for turbo to use them._
 _See: https://turborepo.com/docs/reference/system-environment-variables_
 
 ### Stopping the Server
@@ -148,41 +147,11 @@ _See: https://turborepo.com/docs/reference/system-environment-variables_
 To stop the cache server:
 
 ```bash
+turbogha --kill
+# or
 curl -X DELETE http://localhost:41230/shutdown
 ```
 
-### Development Workflow Example
-
-1. **Start the cache server:**
-
-   ```bash
-   npx turbogha
-   ```
-
-2. **Set up environment variables:**
-
-   ```bash
-   export TURBO_API=http://localhost:41230
-   export TURBO_TOKEN=turbogha
-   export TURBO_TEAM=turbogha
-   ```
-
-3. **Run your builds with remote caching:**
-
-   ```bash
-   turbo build
-   turbo test
-   ```
-
-4. **Stop the server when done:**
-   ```bash
-   curl -X DELETE http://localhost:41230/shutdown
-   ```
-
-This setup allows you to use the same S3-based caching infrastructure locally
-that you use in your CI pipeline, ensuring consistent caching behavior across
-environments.
-
 ## Configurable Options
 
 Customize the caching behavior with the following optional settings (defaults
@@ -231,7 +200,7 @@ Example S3 configuration:
 
 ```yaml
 - name: Cache for Turbo
-  uses: rharkor/caching-for-turbo@v2.0.0
+  uses: rharkor/caching-for-turbo@v2.1.0
   with:
     provider: s3
     s3-access-key-id: ${{ secrets.S3_ACCESS_KEY_ID }}
@@ -269,7 +238,7 @@ Example with cleanup configuration:
 
 ```yaml
 - name: Cache for Turbo
-  uses: rharkor/caching-for-turbo@v2.0.0
+  uses: rharkor/caching-for-turbo@v2.1.0
   with:
     provider: s3
     s3-access-key-id: ${{ secrets.S3_ACCESS_KEY_ID }}
@@ -314,4 +283,3 @@ file.
 This project is inspired by
 [dtinth](https://github.com/dtinth/setup-github-actions-caching-for-turbo) and
 has been comprehensively rewritten for enhanced robustness and reliability.
-

package/dist/cli/index.js

@@ -202048,7 +202048,7 @@ const ping = async () => {
 // EXTERNAL MODULE: external "fs/promises"
 var promises_ = __nccwpck_require__(91943);
 ;// CONCATENATED MODULE: ./package.json
-const package_namespaceObject = {"rE":"1.0.2"};
+const package_namespaceObject = {"rE":"2.1.0"};
 ;// CONCATENATED MODULE: ./src/cli.ts
 
 
@@ -202063,19 +202063,20 @@ const package_namespaceObject = {"rE":"1.0.2"};
 const cli_main = async () => {
     await logger.init();
     const args = process.argv.slice(2);
-    if (args.includes('--help') || args.includes('-h')) {
-        console.log(`
+    const command = args[0];
+    const help = `
 Turborepo GitHub Actions Cache Server
 
 Usage:
-  turbogha [options]
+  turbogha <command> [options]
 
-Options:
-  --server          Run the server in foreground mode
-  --help, -h        Show this help message
-  --version, -v     Show version
-  --ping            Ping the server
-  --kill            Kill the server
+Commands:
+  start             Start the cache server (default: background mode)
+  start --foreground Start the cache server in foreground mode
+  kill              Kill the running server
+  ping              Ping the server to check if it's running
+  help              Show this help message
+  version           Show version
 
 Environment Variables:
   The following environment variables are supported for S3 configuration:
@@ -202088,47 +202089,72 @@ Environment Variables:
   - PROVIDER: Cache provider (github or s3)
 
 Examples:
-  # Run server in background and export environment variables
-  turbogha
+  # Start server in background and export environment variables
+  turbogha start
 
-  # Run server in foreground mode
-  turbogha --server
+  # Start server in foreground mode
+  turbogha start --foreground
 
   # Ping the server
-  turbogha --ping
+  turbogha ping
+
+  # Kill the server
+  turbogha kill
 
   # With S3 configuration
-  S3_ACCESS_KEY_ID=your-key S3_SECRET_ACCESS_KEY=your-secret S3_BUCKET=your-bucket S3_REGION=us-east-1 turbogha
-`);
+  S3_ACCESS_KEY_ID=your-key S3_SECRET_ACCESS_KEY=your-secret S3_BUCKET=your-bucket S3_REGION=us-east-1 turbogha start
+`;
+    if (!command ||
+        command === '--help' ||
+        command === '-h' ||
+        command === 'help') {
+        console.log(help);
         process.exit(0);
     }
-    if (args.includes('--version') || args.includes('-v')) {
+    if (command === '--version' || command === '-v' || command === 'version') {
         console.log(package_namespaceObject.rE);
         process.exit(0);
     }
+    const startForeground = async () => {
+        // Empty log file
+        await (0,promises_.writeFile)(serverLogFile, '', { flag: 'w' });
+        // Run server in foreground mode
+        console.log('Starting Turborepo cache server in foreground mode...');
+        await server();
+    };
+    if (command === '--server') {
+        await startForeground();
+        return;
+    }
     try {
-        if (args.includes('--ping')) {
-            await ping();
-        }
-        else if (args.includes('--kill')) {
-            await killServer();
-        }
-        else if (args.includes('--server')) {
-            // Empty log file
-            await (0,promises_.writeFile)(serverLogFile, '', { flag: 'w' });
-            // Run server in foreground mode
-            console.log('Starting Turborepo cache server in foreground mode...');
-            await server();
-        }
-        else {
-            // Run server in background mode and export environment variables
-            console.log('Starting Turborepo cache server...');
-            // Empty log file
-            await (0,promises_.writeFile)(serverLogFile, '', { flag: 'w' });
-            await launchServer();
-            console.log('\nServer is running! You can now use Turbo with remote caching.');
-            console.log('\nTo stop the server, run:');
-            console.log('curl -X DELETE http://localhost:41230/shutdown');
+        switch (command) {
+            case 'ping':
+                await ping();
+                break;
+            case 'kill':
+                await killServer();
+                break;
+            case 'start': {
+                const isForeground = args.includes('--foreground');
+                if (isForeground) {
+                    await startForeground();
+                }
+                else {
+                    // Run server in background mode and export environment variables
+                    console.log('Starting Turborepo cache server...');
+                    // Empty log file
+                    await (0,promises_.writeFile)(serverLogFile, '', { flag: 'w' });
+                    await launchServer();
+                    console.log('\nServer is running! You can now use Turbo with remote caching.');
+                    console.log('\nTo stop the server, run:');
+                    console.log('turbogha kill');
+                }
+                break;
+            }
+            default:
+                console.error(`Unknown command: ${command}`);
+                console.log(help);
+                process.exit(1);
         }
     }
     catch (error) {