Skip to main content

Manage Configuration

Instead of manually editing flow.json, use the Flow CLI's config commands to add, remove, and manage your project configuration. These commands provide validation and ensure your configuration is properly formatted.

Basic Commands​


_10
# Add configuration items
_10
flow config add <account|contract|network|deployment>
_10
_10
# Remove configuration items
_10
flow config remove <account|contract|network|deployment>

Adding Configuration​

Add an Account​


_10
flow config add account

You can use flags to specify account details:


_10
flow config add account \
_10
--name my-testnet-account \
_10
--address f8d6e0586b0a20c7 \
_10
--private-key ae1b44c0f5e8f6992ef2348898a35e50a8b0b9684000da8b1dade1b3bcd6ebee \
_10
--sig-algo ECDSA_P256 \
_10
--hash-algo SHA3_256 \
_10
--key-index 0

Available flags:

  • --name: Account name
  • --address: Account address
  • --private-key: Private key
  • --sig-algo: Signature algorithm (default: ECDSA_P256)
  • --hash-algo: Hash algorithm (default: SHA3_256)
  • --key-index: Key index (default: 0)

What gets added to flow.json:


_10
"accounts": {
_10
"my-testnet-account": {
_10
"address": "f8d6e0586b0a20c7",
_10
"key": "ae1b44c0f5e8f6992ef2348898a35e50a8b0b9684000da8b1dade1b3bcd6ebee"
_10
}
_10
}

Add a Contract​


_10
flow config add contract

You can use flags to specify contract details:


_10
flow config add contract \
_10
--name MyToken \
_10
--filename ./cadence/contracts/MyToken.cdc \
_10
--testnet-alias 9a0766d93b6608b7 \
_10
--mainnet-alias f233dcee88fe0abe

Available flags:

  • --name: Contract name
  • --filename: Path to contract source file
  • --testnet-alias: Address for testnet alias
  • --mainnet-alias: Address for mainnet alias
  • --emulator-alias: Address for emulator alias

What gets added to flow.json:


_10
"contracts": {
_10
"MyToken": {
_10
"source": "./cadence/contracts/MyToken.cdc",
_10
"aliases": {
_10
"testnet": "9a0766d93b6608b7",
_10
"mainnet": "f233dcee88fe0abe"
_10
}
_10
}
_10
}

Add a Network​


_10
flow config add network

You can use flags to specify network details:


_10
flow config add network \
_10
--name custom-testnet \
_10
--host access-001.devnet30.nodes.onflow.org:9001 \
_10
--network-key ba69f7d2e82b9edf25b103c195cd371cf0cc047ef8884a9bbe331e62982d46daeebf836f7445a2ac16741013b192959d8ad26998aff12f2adc67a99e1eb2988d

Available flags:

  • --name: Network name
  • --host: Flow Access API host address
  • --network-key: Network key for secure connections

What gets added to flow.json:


_10
"networks": {
_10
"custom-testnet": {
_10
"host": "access-001.devnet30.nodes.onflow.org:9001",
_10
"key": "ba69f7d2e82b9edf25b103c195cd371cf0cc047ef8884a9bbe331e62982d46daeebf836f7445a2ac16741013b192959d8ad26998aff12f2adc67a99e1eb2988d"
_10
}
_10
}

Add a Deployment​


_10
flow config add deployment

You can use flags to specify deployment details:


_10
flow config add deployment \
_10
--network testnet \
_10
--account my-testnet-account \
_10
--contract MyToken

Available flags:

  • --network: Network name for deployment
  • --account: Account name for deployment
  • --contract: Contract name(s) to deploy (can specify multiple)

What gets added to flow.json:


_10
"deployments": {
_10
"testnet": {
_10
"my-testnet-account": ["MyToken"]
_10
}
_10
}

Removing Configuration​

Remove an Account​


_10
flow config remove account my-testnet-account

Remove a Contract​


_10
flow config remove contract MyToken

Remove a Network​


_10
flow config remove network custom-testnet

Remove a Deployment​


_10
flow config remove deployment my-testnet-account testnet

Note: This removes all deployments for the specified account on the specified network.

Configuration File Management​

Using Custom Configuration Files​


_10
# Use a specific configuration file
_10
flow config add account --config-path ./config/flow.json
_10
_10
# Use multiple configuration files (merged in order)
_10
flow config add account -f flow.json -f private.json

Configuration File Priority​

When using multiple configuration files with -f flag:

  1. Files are merged from left to right
  2. Later files override earlier ones for overlapping properties
  3. Non-overlapping properties are combined

Example:


_10
flow config add account -f flow.json -f private.json

If both files have an admin-account, the one from private.json will be used.

Security Best Practices​

For better security, consider using separate configuration files for sensitive data:

Main configuration file (flow.json):


_11
{
_11
"accounts": {
_11
"my-testnet-account": {
_11
"address": "3ae53cb6e3f42a79",
_11
"key": {
_11
"type": "file",
_11
"location": "./my-testnet-account.key"
_11
}
_11
}
_11
}
_11
}

Private key file (my-testnet-account.key):


_10
334232967f52bd75234ae9037dd4694c1f00baad63a10c35172bf65fbb8ad1111

Private configuration file (private.json):


_10
{
_10
"accounts": {
_10
"my-testnet-account": {
_10
"address": "3ae53cb6e3f42a79",
_10
"key": "334232967f52bd75234ae9037dd4694c1f00baad63a10c35172bf65fbb8ad1111"
_10
}
_10
}
_10
}

⚠️ Important: Always add private files to .gitignore to prevent committing sensitive data to source control.

Validation​

The config add command validates all inputs:

  • Account addresses must be valid Flow addresses (16-character hex)
  • Private keys must be valid hex-encoded keys
  • Contract sources must point to existing .cdc files
  • Network hosts must be valid host:port combinations
  • Deployments must reference existing accounts and contracts

Best Practices​

  1. Use CLI commands instead of manual editing when possible
  2. Validate your configuration by running flow config add commands
  3. Use descriptive names for accounts and contracts
  4. Keep sensitive data separate using multiple config files
  5. Test deployments on emulator before adding to testnet/mainnet

Common Use Cases​

Setting Up a New Project​


_14
# Initialize project
_14
flow init
_14
_14
# Add your contracts
_14
flow config add contract --name MyToken --filename ./cadence/contracts/MyToken.cdc
_14
flow config add contract --name MyNFT --filename ./cadence/contracts/MyNFT.cdc
_14
_14
# Create accounts for different networks
_14
flow config add account --name emulator-account --address f8d6e0586b0a20c7 --private-key ae1b44c0f5e8f6992ef2348898a35e50a8b0b9684000da8b1dade1b3bcd6ebee
_14
flow config add account --name testnet-account --address 3ae53cb6e3f42a79 --private-key 12332967fd2bd75234ae9037dd4694c1f00baad63a10c35172bf65fbb8ad1111
_14
_14
# Configure deployments
_14
flow config add deployment --network emulator --account emulator-account --contract MyToken --contract MyNFT
_14
flow config add deployment --network testnet --account testnet-account --contract MyToken --contract MyNFT

Adding to Existing Project​


_10
# Add new contract
_10
flow config add contract --name NewContract --filename ./cadence/contracts/NewContract.cdc
_10
_10
# Add deployment for new contract
_10
flow config add deployment --network testnet --account testnet-account --contract NewContract

Managing Multiple Environments​


_10
# Use separate config files for different environments
_10
flow config add account --name admin-account --address f8d6e0586b0a20c7 --private-key ae1b44c0f5e8f6992ef2348898a35e50a8b0b9684000da8b1dade1b3bcd6ebee -f flow.json
_10
flow config add account --name admin-account --address f1d6e0586b0a20c7 --private-key 3335dfdeb0ff03a7a73ef39788563b62c89adea67bbb21ab95e5f710bd1d40b7 -f private.json

Rate this page