# kv

**Repository Path**: go-libs/kv

## Basic Information

- **Project Name**: kv
- **Description**: Read remote configurations from consul, nacos then save to target directory
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-01-22
- **Last Updated**: 2025-07-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# KV

Read K/V from server then save to local files.

## Consul

Read K/V from consul server, You can run `kv -c consul` for help information.

```shell
kv consul \
   --host=192.168.0.100:8500 \
   --name=you-app-name-in-consul-kv \
   --path=/data \
   --override
```

**Options**:

| Symbol         | Default        | Description                           |
|----------------|----------------|---------------------------------------|
| -h, --host     | 127.0.0.1:8500 | Consul server address                 |
| -n, --name     |                | Name of KV                            |
| -o, --override |                | Override the generated file if exists |
| -p, --path     |                | Location for Generated files          |

**Variables**

- `{{path/name}}`
  ```yaml
  databases:
    db:
      dsn:
        - {{mysql/username}}:{{mysql/password}}@tcp({{mysql/host}}:{{mysql/port}})/example?charset={{mysql/charset}}
  ```
- `kv://path/name`
  ```yaml
  databases:
    db:
      dsn:
        - kv://mysql/username:kv://mysql/password@tcp(kv://mysql/host:kv://mysql/port)/example?charset=kv://mysql/charset
  ```

## Nacos

Read K/V from nacos server, You can run `kv -c nacos` for help information.

```shell
kv nacos \
   --data-id="your-data-id" \
   --path=/data
```

**Options**:

| Symbol          | Default        | Description                           |
|-----------------|----------------|---------------------------------------|
| -d, --data-id   |                | Data ID                               |
| -g, --group     | DEFAULT_GROUP  | Nacos group name                      |
| -h, --host      | 127.0.0.1:8848 | Nacos server address                  |
| -n, --namespace | public         | Nacos namespace                       |
| -o, --override  |                | Override the generated file if exists |
| -p, --path      |                | Location for Generated files          |

**Variables**

- `{{NAME}}`
- `{{GROUP:NAME}}`
- `{{NAMESPACE:GROUP:NAME}}`