cosmos-sdk/tools/confix
dependabot[bot] 8a46a3d4fe
build(deps): Bump cosmossdk.io/api from 0.3.0 to 0.3.1 (#15092)
Bumps [cosmossdk.io/api](https://github.com/cosmos/cosmos-sdk) from 0.3.0 to 0.3.1.
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a href="https://github.com/cosmos/cosmos-sdk/blob/v0.3.1/CHANGELOG.md">cosmossdk.io/api's changelog</a>.</em></p>
<blockquote>
<h2>0.3.1 (March 23, 2017)</h2>
<p>IMPROVEMENTS:</p>
<ul>
<li>CLI returns exit code 1 and logs error before exiting</li>
</ul>
</blockquote>
</details>
<details>
<summary>Commits</summary>
<ul>
<li>See full diff in <a href="https://github.com/cosmos/cosmos-sdk/compare/v0.3.0...v0.3.1">compare view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=cosmossdk.io/api&package-manager=go_modules&previous-version=0.3.0&new-version=0.3.1)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)


</details>
2023-02-20 20:39:19 +00:00
..
cmd fix(confix): wrong key set using set command (#14962) 2023-02-09 06:03:23 +00:00
data docs: correct rpc-max-body-bytes config description (#14935) 2023-02-07 09:19:32 +00:00
testdata feat: create config fix tool (#14342) 2023-01-10 10:28:41 +00:00
.gitignore feat: create config fix tool (#14342) 2023-01-10 10:28:41 +00:00
.goreleaser.yml feat: create config fix tool (#14342) 2023-01-10 10:28:41 +00:00
CHANGELOG.md feat: add diff and home command in confix (#14568) 2023-01-16 13:27:41 +00:00
diff.go feat: add diff and home command in confix (#14568) 2023-01-16 13:27:41 +00:00
doc.go feat: create config fix tool (#14342) 2023-01-10 10:28:41 +00:00
file.go feat: add diff and home command in confix (#14568) 2023-01-16 13:27:41 +00:00
go.mod build(deps): Bump cosmossdk.io/api from 0.3.0 to 0.3.1 (#15092) 2023-02-20 20:39:19 +00:00
go.sum build(deps): Bump cosmossdk.io/api from 0.3.0 to 0.3.1 (#15092) 2023-02-20 20:39:19 +00:00
log.go feat: create config fix tool (#14342) 2023-01-10 10:28:41 +00:00
Makefile feat: create config fix tool (#14342) 2023-01-10 10:28:41 +00:00
migrations.go refactor: fix lint issues + gofumpt (#15062) 2023-02-19 10:31:49 +00:00
README.md feat: add diff and home command in confix (#14568) 2023-01-16 13:27:41 +00:00
sonar-project.properties ci: make sonarcloud more quiet (#14585) 2023-01-12 10:24:56 +00:00
upgrade_test.go refactor: rename to CometBFT (#14914) 2023-02-06 18:11:14 +00:00
upgrade.go refactor: fix lint issues + gofumpt (#15062) 2023-02-19 10:31:49 +00:00

sidebar_position
1

Confix

Confix is a configuration management tool that allows you to manage your configuration via CLI.

It is based on the Tendermint RFC 019.

Installation

Add Config Command

To add the confix tool, it's required to add the ConfigCommand to your application's root command file (e.g. simd/cmd/root.go).

Import the confixCmd package:

import "cosmossdk.io/tools/confix/cmd"

Find the following line:

initRootCmd(rootCmd, encodingConfig)

After that line, add the following:

rootCmd.AddCommand(
    confixcmd.ConfigCommand(),
)

The ConfixCommand function builds the config root command and is defined in the confixCmd package (cosmossdk.io/tools/confix/cmd). An implementation example can be found in simapp.

The command will be available as simd config.

Using Confix Standalone

To use Confix standalone, without having to add it in your application, install it with the following command:

go install cosmossdk.io/tools/confix/cmd/confix@latest

:::warning Currently, due to the replace directive in the Confix go.mod, it is not possible to use go install. Building from source or importing in an application is required until that replace directive is removed. :::

Alternatively, for building from source, simply run make confix. The binary will be located in tools/confix.

Usage

Use standalone:

confix --help

Use in simd:

simd config fix --help

Get

Get a configuration value, e.g.:

simd config get app pruning # gets the value pruning from app.toml
simd config get client chain-id # gets the value chain-id from client.toml
confix get ~/.simapp/config/app.toml pruning # gets the value pruning from app.toml
confix get ~/.simapp/config/client.toml chain-id # gets the value chain-id from client.toml

Set

Set a configuration value, e.g.:

simd config set app pruning "enabled" # sets the value pruning from app.toml
simd config set client chain-id "foo-1" # sets the value chain-id from client.toml
confix set ~/.simapp/config/app.toml pruning "enabled" # sets the value pruning from app.toml
confix set ~/.simapp/config/client.toml chain-id "foo-1" # sets the value chain-id from client.toml

Migrate

Migrate a configuration file to a new version, e.g.:

simd config migrate v0.47 # migrates defaultHome/config/app.toml to the latest v0.47 config
confix migrate v0.47 ~/.simapp/config/app.toml # migrate ~/.simapp/config/app.toml to the latest v0.47 config

Diff

Get the diff between a given configuration file and the default configuration file, e.g.:

simd config diff v0.47 # gets the diff between defaultHome/config/app.toml and the latest v0.47 config
confix diff v0.47 ~/.simapp/config/app.toml # gets the diff between ~/.simapp/config/app.toml and the latest v0.47 config

Maintainer

At each SDK modification of the default configuration, add the default SDK config under data/v0.XX-app.toml. This allows users to use the tool standalone.

Credits

This project is based on the Tendermint RFC 019 and their own implementation of confix.