@tigrisdata/cli 2.1.1 → 2.2.0

package/dist/specs.yaml

@@ -71,27 +71,121 @@ definitions:
       value: syd
       description: Sydney, Australia
 
-  access_options: &access_options
-    [public, private]
+  access_options: &access_options [public, private]
 
 commands:
+  #########################
+  # Authentication
+  #########################
+  # configure
+  - name: configure
+    description: Save credentials permanently. After running this, all commands work automatically
+    alias: c
+    messages:
+      onStart: 'Saving credentials...'
+      onSuccess: 'Credentials saved to ~/.tigris/config.json. You can now use all tigris commands.'
+      onFailure: 'Failed to save credentials'
+    arguments:
+      - name: access-key
+        description: Your Tigris access key ID
+        alias: key
+        required: false
+      - name: access-secret
+        description: Your Tigris secret access key
+        alias: secret
+        required: false
+      - name: endpoint
+        description: 'Tigris API endpoint (default: https://t3.storage.dev)'
+        alias: e
+        required: false
+
+  # login
+  - name: login
+    description: Start a session. Use OAuth (default) or temporary credentials that override your saved config
+    messages:
+      onStart: ''
+      onSuccess: 'Login successful'
+      onFailure: 'Login failed'
+    alias: l
+    arguments:
+      - name: access-key
+        description: Use temporary credentials instead of OAuth (useful for testing different keys)
+        alias: key
+        required: false
+      - name: access-secret
+        description: Secret for temporary credentials
+        alias: secret
+        required: false
+    operations:
+      # login (main interactive operation)
+      - name: select
+        description: Choose how to login - OAuth (browser) or credentials (access key)
+        messages:
+          onStart: ''
+          onSuccess: 'Login successful'
+          onFailure: 'Login failed'
+      # oauth
+      - name: oauth
+        description: Login via browser (OAuth2 device flow). Best for interactive use
+        alias: o
+        messages:
+          onStart: 'Opening browser for authentication...'
+          onSuccess: "Logged in successfully\nOrganization '{{org}}' selected"
+          onFailure: 'Authentication failed'
+          onAlreadyDone: "Already logged in.\nRun \"tigris logout\" first to switch accounts."
+          hint: "You have {{count}} organizations.\nRun \"tigris orgs list\" to switch."
+      # credentials
+      - name: credentials
+        description: Login with access key + secret. Creates a temporary session (cleared on logout)
+        alias: c
+        messages:
+          onStart: 'Authenticating...'
+          onSuccess: 'Logged in with credentials'
+          onFailure: 'Authentication failed'
+        arguments:
+          - name: access-key
+            description: Your access key ID (will prompt if not provided)
+            alias: key
+            required: false
+          - name: access-secret
+            description: Your secret access key (will prompt if not provided)
+            alias: secret
+            required: false
+    default: select
+
+  # whoami
+  - name: whoami
+    description: Show information about the current user
+    alias: w
+    messages:
+      onStart: ''
+      onSuccess: ''
+      onFailure: 'Failed to get user information'
+      onAlreadyDone: "Not authenticated\nRun \"tigris login\" to authenticate"
+
+  # logout
+  - name: logout
+    description: End your session. Clears login state but keeps credentials from 'configure'
+    messages:
+      onStart: 'Logging out...'
+      onSuccess: 'Logged out. Your configured credentials are still saved.'
+      onFailure: 'Failed to logout'
+
   #########################
   # Unix style commands
   #########################
-  
   # ls
   - name: ls
     description: List buckets or objects in a bucket or path
     alias: list
     arguments:
       - name: path
-        required: true
-        type: noun
-        description: a bucket or path in a bucket
+        type: positional
+        description: a bucket or path in a bucket (if not provided, lists all buckets)
         examples:
           - my-bucket
           - my-bucket/my-path
-  
+
   # mk
   - name: mk
     description: Create a bucket or a folder in a bucket
@@ -99,25 +193,36 @@ commands:
     arguments:
       - name: path
         required: true
-        type: noun
+        type: positional
         description: a bucket or a folder in a bucket
         examples:
           - my-bucket
           - my-bucket/my-path
-  
+
+  # touch
+  - name: touch
+    description: Create an empty object in a bucket
+    arguments:
+      - name: path
+        required: true
+        type: positional
+        description: path to the object (bucket/key)
+        examples:
+          - my-bucket/my-file.txt
+
   # stat
   - name: stat
     description: Get the details of a bucket or a folder in a bucket or an object in a bucket or path
     arguments:
       - name: path
         required: true
-        type: noun
+        type: positional
         description: a bucket or a folder in a bucket or an object in a bucket or path
         examples:
           - my-bucket
           - my-bucket/my-path
           - my-bucket/my-path/my-object.json
-  
+
   # cp
   - name: cp
     description: Copy a folder or an object
@@ -125,7 +230,7 @@ commands:
     arguments:
       - name: src
         required: true
-        type: noun
+        type: positional
         description: a bucket, a folder in a bucket, an object in a bucket / path. Wildcard is supported.
         examples:
           - my-bucket
@@ -133,43 +238,46 @@ commands:
           - my-bucket/my-path/my-object.json
       - name: dest
         required: true
-        type: noun
+        type: positional
         description: path to copy to
         examples:
           - my-bucket
           - my-bucket/my-path
           - my-bucket/my-path/*
           - my-bucket/my-path/my-object.json
-  
+
   # mv
   - name: mv
     description: Move a folder or an object
     alias: move
     arguments:
       - name: src
-        type: noun
+        type: positional
         required: true
         description: path to move from
         examples:
-          - my-bucket
           - my-bucket/my-path
           - my-bucket/my-path/*
           - my-bucket/my-path/my-object.json
       - name: dest
-        type: noun
+        type: positional
         required: true
         description: path to move to
         examples:
           - my-bucket
           - my-bucket/new-path
-  
+      - name: force
+        type: flag
+        alias: f
+        description: Skip confirmation prompt
+
   # rm
   - name: rm
     description: Remove a bucket or a folder in a bucket or an object in a bucket or path
-    alias: remvoe
+    alias: remove
     arguments:
       - name: path
-        type: noun
+        type: positional
         required: true
         description: a bucket, a folder in a bucket, an object in a bucket / path. Wildcard is supported.
         examples:
@@ -177,137 +285,16 @@ commands:
           - my-bucket/my-path
           - my-bucket/my-path/*
           - my-bucket/my-path/my-object.json
-
-  #########################
-  # Authentication
-  #########################
-  # logout
-  - name: logout
-    description: Logout from Tigris
-    messages:
-      onStart: "Logging out..."
-      onSuccess: "Logged out successfully"
-      onFailure: "Failed to logout"
-
-  # whoami
-  - name: whoami
-    description: Show information about the current user
-    alias: w
-    messages:
-      onStart: ""
-      onSuccess: ""
-      onFailure: "Failed to get user information"
-      onAlreadyDone: "Not authenticated\nRun \"tigris login\" to authenticate"
-  
-  # configure
-  - name: configure
-    description: Configure Tigris credentials interactively
-    alias: c
-    messages:
-      onStart: "Configuring credentials..."
-      onSuccess: "Configuration saved"
-      onFailure: "Failed to configure credentials"
-    arguments:
-      - name: access-key
-        description: Tigris Access key ID
-        alias: key
-        required: false
-      - name: access-secret
-        description: Tigris Access secret
-        alias: secret
-        required: false
-      - name: endpoint
-        description: Tigris Endpoint
-        alias: e
-        required: false
-
-  # login
-  - name: login
-    description: Login to Tigris (interactive selection between user and machine)
-    messages:
-      onStart: "Logging in..."
-      onSuccess: "Login successful"
-      onFailure: "Login failed"
-    alias: l
-    arguments:
-      - name: access-key
-        description: Access key (optional, will use credentials flow if provided)
-        alias: key
-        required: false
-      - name: access-secret
-        description: Access secret (optional, will use credentials flow if provided)
-        alias: secret
-        required: false
-      - name: profile
-        description: Use saved credentials profile (loads from ~/.tigris/credentials.json)
-        alias: p
-        required: false
+      - name: force
         type: flag
-      - name: oauth
-        description: Login as a user (OAuth2 flow)
-        alias: o
-        required: false
-        type: flag
-    operations:
-      # login (main interactive operation)
-      - name: select
-        description: Interactive selection between user and machine login
-        messages:
-          onStart: ""
-          onSuccess: "Login successful"
-          onFailure: "Login failed"
-        arguments:
-          - name: access-key
-            description: Access key (optional, will use credentials flow if provided)
-            alias: key
-            required: false
-          - name: access-secret
-            description: Access secret (optional, will use credentials flow if provided)
-            alias: secret
-            required: false
-          - name: profile
-            description: Use saved credentials profile (loads from ~/.tigris/credentials.json)
-            alias: p
-            required: false
-            type: flag
-          - name: oauth
-            description: Login as a user (OAuth2 flow)
-            alias: o
-            required: false
-            type: flag
-      # ui
-      - name: ui
-        description: Login as a user (OAuth2 flow)
-        alias: u
-        messages:
-          onStart: "Initiating authentication..."
-          onSuccess: "Authentication successful\nOrganization '{{org}}' selected"
-          onFailure: "Authentication failed"
-          onAlreadyDone: "You are already logged in.\nRun \"tigris logout\" first if you want to login with a different account."
-          hint: "You have {{count}} organizations available.\nRun \"tigris orgs list\" to see all and switch if needed."
-      # credentials
-      - name: credentials
-        description: Login as a machine (with access key and secret)
-        alias: c
-        messages:
-          onStart: "Authenticating with credentials..."
-          onSuccess: "Login successful"
-          onFailure: "Login failed"
-        arguments:
-          - name: access-key
-            description: Access key (optional, will prompt or use saved credentials if not provided)
-            alias: key
-            required: false
-          - name: access-secret
-            description: Access secret (optional, will prompt or use saved credentials if not provided)
-            alias: secret
-            required: false
-    default: select
+        alias: f
+        description: Skip confirmation prompt
 
   #########################
   # Manage organizations
   #########################
-  - name: orgs
+  - name: organizations
+    alias: orgs
     description: Manage organizations
     operations:
       # list
@@ -315,9 +302,9 @@ commands:
         description: List organizations
         alias: l
         messages:
-          onStart: "Listing organizations..."
+          onStart: 'Listing organizations...'
           onSuccess: "Organization '{{name}}' selected"
-          onFailure: "Failed to select organization"
+          onFailure: 'Failed to select organization'
           onEmpty: "No organizations found. You may need to re-authenticate.\nRun: tigris login"
         arguments:
           - name: format
@@ -333,25 +320,25 @@ commands:
         description: Create organization
         alias: c
         messages:
-          onStart: "Creating organization..."
+          onStart: 'Creating organization...'
           onSuccess: "Organization '{{name}}' created successfully\nOrganization ID: {{id}}"
-          onFailure: "Failed to create organization"
+          onFailure: 'Failed to create organization'
           hint: "Next steps:\n   - Select this organization: tigris orgs select {{name}}"
         arguments:
           - name: name
-            type: noun
+            type: positional
             required: true
             description: Name of the organization
       - name: select
         description: Select the organization to use
         alias: s
         messages:
-          onStart: ""
+          onStart: ''
           onSuccess: "Organization '{{name}}' selected"
-          onFailure: "Failed to select organization"
+          onFailure: 'Failed to select organization'
         arguments:
           - name: name
-            type: noun
+            type: positional
             required: true
             description: Name of the organization
 
@@ -367,10 +354,10 @@ commands:
         description: List buckets
         alias: l
         messages:
-          onStart: "Listing buckets..."
-          onSuccess: "Found {{count}} bucket(s)"
-          onFailure: "Failed to list buckets"
-          onEmpty: "No buckets found"
+          onStart: 'Listing buckets...'
+          onSuccess: 'Found {{count}} bucket(s)'
+          onFailure: 'Failed to list buckets'
+          onEmpty: 'No buckets found'
         arguments:
           - name: format
             description: Format
@@ -382,13 +369,13 @@ commands:
         description: Create bucket
         alias: [c]
         messages:
-          onStart: "Creating bucket..."
+          onStart: 'Creating bucket...'
           onSuccess: "Bucket '{{name}}' created successfully"
-          onFailure: "Failed to create bucket"
+          onFailure: 'Failed to create bucket'
         arguments:
           - name: name
             description: Name of the bucket
-            type: noun
+            type: positional
             required: false
           - name: access
             description: Access level
@@ -420,29 +407,29 @@ commands:
         description: Get bucket details
         alias: g
         messages:
-          onStart: "Getting bucket details..."
-          onSuccess: ""
-          onFailure: "Failed to get bucket details"
+          onStart: 'Getting bucket details...'
+          onSuccess: ''
+          onFailure: 'Failed to get bucket details'
         arguments:
           - name: name
             description: Name of the bucket
-            type: noun
+            type: positional
             required: true
       # delete
       - name: delete
         description: Delete bucket
         alias: d
         messages:
-          onStart: "Deleting bucket..."
+          onStart: 'Deleting bucket...'
           onSuccess: "Bucket '{{name}}' deleted successfully"
           onFailure: "Failed to delete bucket '{{name}}'"
         arguments:
           - name: name
             description: Name of the bucket or comma separated list of buckets
-            type: noun
+            type: positional
             required: true
             multiple: true
-  
+
   #########################
   # Manage forks
   #########################
@@ -452,27 +439,44 @@ commands:
     operations:
       # list
       - name: list
-        description: List forks
+        description: List forks of a bucket
         alias: l
+        messages:
+          onStart: 'Listing forks...'
+          onSuccess: 'Found {{count}} fork(s)'
+          onFailure: 'Failed to list forks'
+          onEmpty: 'No forks found for this bucket'
         arguments:
           - name: name
-            description: Name of the bucket
-            type: noun
+            description: Name of the source bucket
+            type: positional
             required: true
+          - name: format
+            description: Output format
+            alias: f
+            options: [json, table, xml]
+            default: table
       # create
       - name: create
-        description: Create fork
+        description: Create a fork of a bucket
         alias: c
+        messages:
+          onStart: 'Creating fork...'
+          onSuccess: "Fork '{{forkName}}' created from '{{name}}'"
+          onFailure: 'Failed to create fork'
         arguments:
           - name: name
-            description: Name of the bucket
-            type: noun
+            description: Name of the source bucket
+            type: positional
             required: true
           - name: fork-name
-            description: Name of the fork
-            type: noun
+            description: Name for the new fork
+            type: positional
             required: true
-  
+          - name: snapshot
+            description: Create fork from a specific snapshot
+            alias: s
+
   #########################
   # Manage snapshots
   #########################
@@ -480,28 +484,42 @@ commands:
     description: Manage snapshots
     alias: s
     operations:
-      # list  
+      # list
       - name: list
-        description: List snapshots
+        description: List snapshots of a bucket
         alias: l
+        messages:
+          onStart: 'Listing snapshots...'
+          onSuccess: 'Found {{count}} snapshot(s)'
+          onFailure: 'Failed to list snapshots'
+          onEmpty: 'No snapshots found for this bucket'
         arguments:
           - name: name
             description: Name of the bucket
-            type: noun
+            type: positional
             required: true
-      # create
-      - name: create
-        description: Create snapshot
-        alias: c
+          - name: format
+            description: Output format
+            alias: f
+            options: [json, table, xml]
+            default: table
+      # take
+      - name: take
+        description: Take a snapshot of a bucket
+        alias: t
+        messages:
+          onStart: 'Taking snapshot...'
+          onSuccess: "Snapshot '{{snapshotName}}' taken for bucket '{{name}}'"
+          onFailure: 'Failed to take snapshot'
         arguments:
           - name: name
             description: Name of the bucket
-            type: noun
+            type: positional
             required: true
           - name: snapshot-name
-            description: Name of the snapshot
-            type: noun
-            required: true
+            description: Name of the snapshot (optional)
+            type: positional
+            required: false
 
   #########################
   # Manage objects
@@ -512,52 +530,70 @@ commands:
     operations:
       # list
       - name: list
-        description: List objects
+        description: List objects in a bucket
         alias: l
+        messages:
+          onStart: 'Listing objects...'
+          onSuccess: 'Found {{count}} object(s)'
+          onFailure: 'Failed to list objects'
+          onEmpty: 'No objects found'
         arguments:
           - name: bucket
             description: Name of the bucket
-            alias: b
+            type: positional
             required: true
+          - name: prefix
+            description: Filter objects by prefix
+            alias: p
           - name: format
-            description: Format
+            description: Output format
             alias: f
             options: [json, table, xml]
             default: table
       # get
       - name: get
-        description: Get object
+        description: Get an object
         alias: g
+        messages:
+          onStart: 'Getting object...'
+          onSuccess: ''
+          onFailure: 'Failed to get object'
         arguments:
           - name: bucket
             description: Name of the bucket
-            type: noun
+            type: positional
             required: true
           - name: key
-            description: Name of the object
-            type: noun
+            description: Key of the object
+            type: positional
             required: true
-          - name: format
-            description: Format
-            alias: f
-            options: [string, file, stream]
-            default: string
-      # create
-      - name: create
-        description: Create object
-        alias: c
+          - name: output
+            description: Output file path (if not specified, prints to stdout)
+            alias: o
+          - name: mode
+            description: Response mode (auto-detected from extension if not specified)
+            alias: m
+            options: [string, stream]
+      # put
+      - name: put
+        description: Upload an object
+        alias: p
+        messages:
+          onStart: 'Uploading object...'
+          onSuccess: "Object '{{key}}' uploaded successfully"
+          onFailure: 'Failed to upload object'
         arguments:
           - name: bucket
             description: Name of the bucket
-            type: noun
+            type: positional
             required: true
-          - name: name
-            description: Name of the object
-            type: noun
+          - name: key
+            description: Key for the object
+            type: positional
             required: true
-          - name: body
-            description: Body of the object
-            alias: d
+          - name: file
+            description: Path to the file to upload
+            type: positional
             required: true
           - name: access
             description: Access level
@@ -566,62 +602,27 @@ commands:
             default: private
           - name: content-type
             description: Content type
-            alias: c
-          - name: content-disposition
-            description: Content disposition
-            alias: d
-          - name: tier
-            description: Tier
             alias: t
-            options: *tier_options
-            default: STANDARD
+          - name: format
+            description: Output format
+            alias: f
+            options: [json, table, xml]
+            default: table
       # delete
       - name: delete
-        description: Delete object
+        description: Delete an object
         alias: d
+        messages:
+          onStart: 'Deleting object...'
+          onSuccess: "Object '{{key}}' deleted successfully"
+          onFailure: 'Failed to delete object'
         arguments:
           - name: bucket
             description: Name of the bucket
-            type: noun
+            type: positional
             required: true
           - name: key
-            description: Name of the object (comma separated names for multiple objects)
-            type: noun
-            required: true
-            multiple: true
-      # copy
-      - name: copy
-        description: Copy object
-        alias: c
-        arguments:
-          - name: bucket
-            description: Name of the bucket
-            type: noun
-            required: true
-          - name: name
-            description: Name of the object (comma separated names for multiple objects)
-            type: noun
+            description: Key of the object (comma separated for multiple)
+            type: positional
             required: true
             multiple: true
-          - name: destination
-            description: Destination
-            type: noun
-            required: true
-      # move
-      - name: move
-        description: Move object
-        alias: m
-        arguments:
-          - name: bucket
-            description: Name of the bucket
-            type: noun
-            required: true
-          - name: source
-            description: Name of the object (comma separated names for multiple objects)
-            type: noun
-            required: true
-            multiple: true
-          - name: destination
-            description: Destination
-            type: noun
-            required: true