path: root/locales/help_docs/en.yml

jvv:
  help: |
    **JustEnoughVCS Upstream Vault Commands**
    This program directly creates, manages, and runs JustEnoughVCS upstream vaults.
    **Tip**: It directly operates on vault data - please operate with caution!
    * With great power comes great responsibility *

    **Create Vault**:
      jvv create <VAULT_NAME> - Create a vault in the given directory name
      jvv init - Create a vault in the current directory

    **Query**:
      jvv here - Query information about the current vault
      jvv member list - Query all members

    **Member Management**:
      jvv member <register/remove> <MEMBER_NAME> - Register or remove members

    **Service**:
      jvv service listen - Run the server in the current vault

    Additionally, you can use jvv <CMD_NAME> --help to query more detailed help!

  here: |
    **Display Vault Information Here**
    **Example**: cd ./target_dir/ && jvv here

  create: |
    **Create a new vault with the given name**
    **Usage**: jvv create <VAULT_NAME>

    **Example**: jvv create MyVault
    Creates a directory named 'MyVault' and initializes a vault inside it.

  init: |
    **Initialize a vault in the current directory**
    **Usage**: jvv init

    Uses the current directory's name as the vault name.

  member: |
    **Member Management**
    **Usage**: jvv member <register/remove> <MEMBER_NAME>

    Register or remove members based on the given member name.

    It is recommended to use the "snake_case" naming format,
    as it will be stored in this format in the configuration file
    **Example**: jvv member register vault_member

    **Query**: jvv member list
    Equivalent to running `jvv here` in the members directory.

    **Tip**: Does not manage private keys automatically. Keys must be handled manually.

  service: |
    **Service Management**
    **Usage**:
    jvv service listen - Start the vault server in the current vault to accept client connections
      You can use --no-log to disable log output

  fail:
    jvcs: "JustEnoughVCS Error: %{err}"
    no_vault_here: No vault found here

    tokio:
      fs:
        create_dir: Failed to create directory %{dir}
        create_dir_all: Failed to create directory %{dir}

    std:
      current_dir: Failed to get current directory
      current_dir_name: Failed to get current directory name
      set_current_dir: Failed to set current directory to %{dir}

    here:
      cfg_not_found:
        Could not find vault configuration!
        If you wish to use this directory as a vault, please use jvv init --help to view related help

      vault_init_failed: Failed to initialize vault!
      member_ids_failed: Failed to get member IDs!
      ref_sheet_not_found: Reference sheet `ref` not found, but it should exist!

    create:
      not_empty: Operation denied! The specified directory already exists.

    init:
      not_empty: Operation denied! The directory is not empty.

    member:
      register: Failed to create member! Please check if a member with the same name already exists
      list: Failed to get member ID!

    service:
      listen_done: |
        Server forced to close due to error!
        Error message: %{error}

  success:
    here:
      info: |
        Found vault *`%{name}`*! (%{num_mem} Members, %{num_pk} registered PubKeys)
        Managing %{num_sheets} Sheets, %{num_vf} VirtualFiles, total %{total_size}

        **Tip**: To start the server, run jvv service listen

    create: Successfully created vault at `%{name}`!

    init: Successfully initialized vault here!

    member:
      register: Successfully created member `%{member}`!
      remove: |
        Successfully removed `%{member}` from the vault!
        (or they were never here?)
      list:
        header: |
          **There are %{num} member(s) in the current vault:**

        footer: |
          **Among them, %{num} members have registered PubKeys.**

        status_key_registered: (Registered)

    service:
      listen_start: Listening for client connections in vault `%{path}` ...
      listen_done: Server shutdown!

jv:
  help: |
    **JustEnoughVCS Local Workspace Commands**
    This program connects to upstream vaults to synchronize and commit changes to local workspace files for collaborative work.

    **Common Aliases**:
      jv u Download latest information, jv t Track files, jv mv -a Auto-move files, jv in/out Import or export files

    **Create Workspace**:
      jv create <NAME> - Create a workspace in the given directory name
      jv init - Create a workspace in the current directory

    **Connect to Upstream Vault**:
      jv direct <UPSTREAM_ADDRESS> - Direct your workspace to this vault
      After specifying an upstream vault, your workspace will be *stained*, and you will not be able to connect to vaults with different identifiers

      jv unstain - Unstain your workspace (remove stain identifier), after which the workspace will be unrelated to any upstream vault

    **Account Management**:
      jv account list - List all accounts on this computer and whether private keys are registered
      jv account as <ACCOUNT_NAME> - Switch current account
      jv account add <ACCOUNT_NAME> - Add an account to this computer
      jv account remove <ACCOUNT_NAME> - Delete this account
      jv account movekey <ACCOUNT_NAME> <PRIVATE_KEY_FILE> - Move private key to specified account

    **Information Synchronization**:
      jv update - Download latest information from upstream workspace

    **Sheet Operations**:
      jv sheet list - List all sheets in the upstream workspace
      jv sheet use <SHEET_NAME> - Use the specified sheet to start current work (automatically created if it doesn't exist)
      jv sheet exit - Exit current work

      jv import <PACKAGE_NAME> - Import files from import area
      jv import <REFERENCE_SHEET_PATH> - Import files from reference sheet
      jv export <FILE> <SHEET_NAME> -m <DESCRIPTION> -n <PACKAGE_NAME> - Export specified file package to import area of other sheets

    **File Operations**
      jv move <FILE> <TO> - Safely rename files
      jv move auto - Automatically handle local file moves or renames
      jv track <FILE> - Track and upload files to upstream vault

    **Query Built-in Documentation**
      jv docs list - List all available documentation
      jv docs <DOC_NAME> - View content of specified documentation
      or jv docs <DOC_NAME> -e - Return temporary path of specific documentation for editor opening
      **Example**: jv docs get-started -e | nano

    You can use jv <COMMAND_NAME> --help to query more detailed help!

    **Tip**: If you need to understand JustEnoughVCS collaboration paradigms, use jv docs get-started

  account: |
    **Manage Local Accounts**
    **Usage**:
    jv account list - List all accounts on this computer and whether private keys are registered
    jv account as <ACCOUNT_NAME> - Switch current account
    jv account add <ACCOUNT_NAME> - Add an account to this computer
    jv account remove <ACCOUNT_NAME> - Delete this account
    jv account movekey <ACCOUNT_NAME> <PRIVATE_KEY_FILE> - Move private key to specified account

    Accounts are identity identifiers on the local computer, each account can be associated with different private keys.
    You need to set up accounts before interacting with upstream vaults.

  sheet: |
    **Manage File Sheets**
    **Usage**:
    jv sheet list - List all sheets in the upstream workspace
    jv sheet use <SHEET_NAME> - Use the specified sheet to start current work (automatically created if it doesn't exist)
    jv sheet exit - Exit current work

    Sheets are core concepts in JustEnoughVCS, each sheet represents an independent file collection.
    You can switch work between different sheets, or export files from one sheet to another.

  create: |
    **Create Workspace with Specified Name**
    **Usage**: jv create <WORKSPACE_NAME>

    **Example**: jv create my_workspace
    Creates a directory named 'my_workspace' in the current directory and initializes a workspace inside it.

    Workspace is your local working environment for file synchronization and version control with upstream vaults.

  init: |
    **Create Workspace in Current Directory**
    **Usage**: jv init

    This command creates a workspace in the current directory, with the workspace name determined by the current directory name.

    If the current directory is not empty, this operation will fail. Please ensure you execute this command in an empty directory.

  here: |
    **Query Directory Information Here**
    **Usage**: jv here

    Displays detailed information about current directory files, including:
    - File name, size, version number
    - Current file holder
    - Latest version commit information

    This is a quick way to understand the current state of your workspace directory.

  track: |
    **Track Local Files**
    **Usage**: jv track <FILE_PATH>

    **Example**: jv track src/main.rs
    First track - Create and upload the "First Version", then automatically hold them
    Subsequent tracks - Update files with new versions

    Tracking files is the basic operation of version control, ensuring your changes can be synchronized to the upstream vault.

  hold: |
    **Hold Files: Obtain File Edit Rights from Upstream Vault**
    **Usage**: jv hold <FILE_PATH>

    **Example**: jv hold src/lib.rs
    When you need to edit a file, you must first hold the file's edit rights.
    After holding a file, other collaborators will not be able to edit the same file simultaneously, avoiding conflicts.

    After editing, remember to track the file to save changes.

  throw: |
    **Throw Files: Release File Edit Rights from Upstream Vault**
    **Usage**: jv throw <FILE_PATH>

    **Example**: jv throw src/config.rs
    When you no longer need to edit a file, you can throw the file's edit rights.
    After throwing, other collaborators can hold and edit the file.

    If you have made changes to the file but haven't tracked them, throwing will lose those changes.

  move: |
    **Move Local Files**
    **Usage**:
    jv move <SOURCE_FILE> <TARGET_LOCATION> - Safely rename or move files
    jv move auto - Automatically handle local file moves or renames

    **Example**:
    jv move old_name.txt new_name.txt
    jv move src/old_dir/file.rs src/new_dir/file.rs
    jv move auto

    Safe move operations preserve file version history, while auto-move detects and handles all renames.

  export: |
    **Export Files to Import Area of Other Sheets**
    **Usage**: jv export <FILE> <TARGET_SHEET> -m <DESCRIPTION> -n <PACKAGE_NAME>

    **Example**: jv export data.csv analytics -m "Export analysis data" -n "analysis_data"
    This operation packages the specified files and sends them to the import area of the target sheet.

    Other collaborators can use the jv import command in the target sheet to import these files.

  import: |
    **Import Files to Current Sheet**
    **Usage**:
    jv import <PACKAGE_NAME> - Import files from import area
    jv import <REFERENCE_SHEET_PATH> - Import files from reference sheet

    **Example**:
    jv import Player_Import - From import area defined name
    jv import ref@Data/Player.csv - From reference sheet path

    Import operation copies files from other sheets or import areas to the current workspace.

  direct: |
    **Direct to Specified Upstream Vault and Stain This Workspace**
    **Usage**: jv direct <UPSTREAM_VAULT_ADDRESS>

    **Example**: jv direct your_vault.org
    This operation connects the current workspace to the specified upstream vault and adds a stain identifier to the workspace.

    After staining, the workspace will only be able to interact with vaults of the specified identifier, ensuring data consistency.

  unstain: |
    **Unstain This Workspace**
    **Usage**: jv unstain

    **DANGER ZONE**: This operation removes the workspace's stain identifier, after which the workspace will be disconnected from the upstream vault.

    After unstaining, the workspace will no longer be associated with any specific vault and can be reconnected to other vaults.
    However, please note that this may cause data synchronization issues, use with caution.

  update: |
    **Download Latest Information from Upstream Vault**
    **Usage**: jv update

    This operation synchronizes the latest file status, sheet information, and member information from the upstream vault.

    It is recommended to perform an update operation before starting work to ensure you have the latest working environment.

  docs: |
    **Query Built-in Documentation**
    **Usage**:
    jv docs list - List all available documentation
    jv docs <DOC_NAME> - View content of specified documentation
    jv docs <DOC_NAME> -e - Return temporary path of specific documentation for editor opening

    **Example**:
    jv docs get-started
    jv docs collaboration -e | nano

    Built-in documentation includes JustEnoughVCS usage guides, collaboration paradigms, and best practices.

  fail:
    path_not_found: |
      The directory `%{path}` cannot be found!

    parse:
      str_to_sockaddr: |
        Could not recognize *`%{str}`* as an IP address
        This is a problem with your input syntax! Please check **the content you entered**

    action_operation_fail:
      main: |
        This error is from the JustEnoughVCS core component
        **Error Message**: %{err}

      type_connection: |
        Based on the returned error context, this is a **network connection** issue
        **Please check**:
        1. Whether your network connection is working properly
        2. Whether you have permission to connect to this address

      type_auth: |
        Based on the returned error context, this is a **permission** issue
        This indicates you don't have sufficient permissions to perform this operation.

      type_fsio: |
        Based on the returned error context, this is a **file read/write** related issue
        **Please check**:
        1. Whether your disk has sufficient space and is operating normally
        2. Whether your Local Workspace files are being used by other processes

      type_serialize: |
        Based on the returned error context, this is a **serialization or deserialization** related issue
        **Please check**
        1. Whether the parameter format you passed meets the requirements for serialization/deserialization
        2. Whether this version of JustEnoughVCS client/server supports this type of serialization

      type_other: |
        Unfortunately, based on the returned context information,
        this is not an expected error.
        Please submit an Issue at the JustEnoughVCS Git Repository

        JustEnoughVCS needs your feedback, which will make this project more "JustEnough"

      info_contact_admin: |
        If necessary, please contact the **administrator** of the Upstream Vault.
        If you are the **administrator** and confirm this issue affects server operation, please:
        1. Check if your JustEnoughVCS server is up to date
        2. Submit an Issue at the JustEnoughVCS Git Repository

    account:
      no_user_dir: Cannot find user directory!
      add: Failed to add account `%{account}`, please check if the account already exists.
      remove: Failed to remove account `%{account}`, please check if the account exists.
      list: Failed to get account list!
      not_found: Cannot find account `%{account}`!

    init_create_dir_not_empty: |
      The current directory is not empty!
      If you are certain you want to create here, please use --force to force execution!

    create: Failed to create local workspace!
    init: Failed to create workspace here!
    get_current_dir: Failed to get current directory!

    workspace_not_found: |
      Local workspace not found! Please use this command within a local workspace
      If you wish to use this directory as a local workspace, please use jv init

    read_cfg: Failed to read local workspace configuration file!
    write_cfg: Failed to write changes to local workspace configuration file!

  success:
    account:
      as: Successfully switched this workspace's account to `%{account}`
      add: Successfully added account `%{account}`!
      remove: Successfully removed account `%{account}`!
      list:
        header: |
          **There are %{num} account(s) on this computer:**

        status_has_key: (Registered)
      move_key: Successfully moved the private key to the account directory!
    create: Successfully created local workspace!
    init: Successfully created workspace here!