Skip to main content
command

gws-vault — Claude Code command: what it does, how to install

Manages eDiscovery matters, legal holds, and data exports in Google Vault using Google Workspace CLI. Fits legal and compliance workflows.

Install into Claude Code · claude-code-templates All methods and platforms ↓
npx claude-code-templates@latest --command google-workspace/gws-vault
Open on GitHub

What gws-vault does

This command directs Claude Code to interact with the Google Vault API v1 via the Google Workspace CLI tool (gws). It formats requests as gws vault <resource> <method> [flags]. Before running actions, the assistant inspects parameter requirements through gws schema.

The logic covers matters and operations resources. It handles opening investigations, assigning matter collaborators, configuring legal holds, and polling asynchronous background jobs.

Without the gws binary and an active session checked by gws auth status, all calls will fail. It also depends on shared configuration rules in ../gws-shared/SKILL.md, generated via gws generate-skills.

What it helps with

  • create legal matters and manage collaborators in Google Vault
  • configure and update eDiscovery holds across workspace accounts
  • export investigation data and query results
  • monitor long-running background operations with operations get

Example prompts for the agent

  • /gws-vault matters list
  • /gws-vault matters create --json '{"name": "Internal-Audit-2025"}'
  • /gws-vault operations get --params matterId=123,operationId=456

How to install gws-vault

1claude-code-templates

npx claude-code-templates@latest --command google-workspace/gws-vault

2Manually: put the files in place

.claude/commands/gws-vault.md

Call it with /gws-vault. For all projects use ~/.claude/commands/

Questions about gws-vault

How to install gws-vault in Claude Code?

Run npx claude-code-templates@latest --command google-workspace/gws-vault in your terminal. Alternatively, place the file directly at .claude/commands/gws-vault.md.

What does gws-vault do?

It allows Claude Code to execute eDiscovery workflows in Google Vault, such as managing legal matters, holds, and exports via the gws CLI.

What are the prerequisites for gws-vault?

You must install the gws CLI, verify authentication with gws auth status, and generate shared skill files using gws generate-skills.

Source text

gws-vault.md · MIT
---
allowed-tools: Bash, Read, Write, Edit
argument-hint: "[resource] [method] [flags]"
description: "Google Vault: Manage eDiscovery holds and exports."
---

# Google Workspace Vault

Execute Google Workspace Vault operations: $ARGUMENTS

## Prerequisites

- Google Workspace CLI (`gws`) must be installed
- Authentication configured: Run `gws auth status` to verify
- Review `gws vault --help` for all available commands

## Available Resources and Methods

# vault (v1)

> **PREREQUISITE:** Read `../gws-shared/SKILL.md` for auth, global flags, and security rules. If missing, run `gws generate-skills` to create it.

```bash
gws vault <resource> <method> [flags]
```

## API Resources

### matters

  - `addPermissions` — Adds an account as a matter collaborator.
  - `close` — Closes the specified matter. Returns the matter with updated state.
  - `count` — Counts the accounts processed by the specified query.
  - `create` — Creates a matter with the given name and description. The initial state is open, and the owner is the method caller. Returns the created matter with default view.
  - `delete` — Deletes the specified matter. Returns the matter with updated state.
  - `get` — Gets the specified matter.
  - `list` — Lists matters the requestor has access to.
  - `removePermissions` — Removes an account as a matter collaborator.
  - `reopen` — Reopens the specified matter. Returns the matter with updated state.
  - `undelete` — Undeletes the specified matter. Returns the matter with updated state.
  - `update` — Updates the specified matter. This updates only the name and description of the matter, identified by matter ID. Changes to any other fields are ignored. Returns the default view of the matter.
  - `exports` — Operations on the 'exports' resource
  - `holds` — Operations on the 'holds' resource
  - `savedQueries` — Operations on the 'savedQueries' resource

### operations

  - `cancel` — Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation.
  - `delete` — Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
  - `get` — Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
  - `list` — Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

## Discovering Commands

Before calling any API method, inspect it:

```bash
# Browse resources and methods
gws vault --help

# Inspect a method's required params, types, and defaults
gws schema vault.<resource>.<method>
```

Use `gws schema` output to build your `--params` and `--json` flags.

## Usage

```bash
# List available resources and methods
gws vault --help

# Inspect method schema before calling
gws schema vault.<resource>.<method>

# Execute command with arguments
gws vault $ARGUMENTS
```

## Task

Execute the requested Vault operation: $ARGUMENTS

1. **Verify Prerequisites**
   - Check `gws` is installed: `gws --version`
   - Verify authentication: `gws auth status`
   - Review available commands: `gws vault --help`

2. **Inspect Method Schema**
   - Before calling any method, inspect its parameters
   - Use `gws schema` to understand required fields
   - Review parameter types and constraints

3. **Execute Operation**
   - Build command with appropriate flags
   - Use `--params` for query/path parameters
   - Use `--json` for request body
   - Handle pagination with `--max-results` or `--page-token`

4. **Error Handling**
   - Check command output for errors
   - Review API quotas and rate limits
   - Handle authentication issues
   - Retry transient failures

---

**License**: Apache License 2.0
**Source**: [Google Workspace CLI](https://github.com/googleworkspace/cli)
**Original Skill**: `gws-vault`

© davila7 · MIT · davila7/claude-code-templates

Similar slash commands

All slash commands for Security →

From the same set804

The whole set →

Project sponsors

Companies that keep this analytics open
Gold sponsor

Impressions, clicks and code copies — open statistics. We keep the numbers public for the same reason NeBlask itself is public. Become a sponsor