diff --git a/docs/tools/flow-cli/migrate/_category_.json b/docs/tools/flow-cli/migrate/_category_.json new file mode 100644 index 0000000000..2c294afb9c --- /dev/null +++ b/docs/tools/flow-cli/migrate/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Migrate Projects to 1.0", + "position": 11 +} diff --git a/docs/tools/flow-cli/migrate/migrate-get-staged-code.md b/docs/tools/flow-cli/migrate/migrate-get-staged-code.md new file mode 100644 index 0000000000..043c085f6c --- /dev/null +++ b/docs/tools/flow-cli/migrate/migrate-get-staged-code.md @@ -0,0 +1,27 @@ +--- +title: Get staged Cadence 1.0 Contract Code +description: How to get staged Cadence 1.0 contract code from the command line +sidebar_position: 5 +--- + +Get the staged contract code from a contract thats been correctly staged. + +```shell +flow migrate staged_code +``` + +## Example Usage + +``` +> flow migrate staged_code HelloWorld --network=testnet + +Attempts to return the contract code of HelloWorld on the Testnet network. + +``` + +## Arguments + +### Contract Name + +- Name: `contract_name` +- Valid Input: Existing contract name in `flow.json`. diff --git a/docs/tools/flow-cli/migrate/migrate-is-staged.md b/docs/tools/flow-cli/migrate/migrate-is-staged.md new file mode 100644 index 0000000000..679d689445 --- /dev/null +++ b/docs/tools/flow-cli/migrate/migrate-is-staged.md @@ -0,0 +1,27 @@ +--- +title: Check if a contract is staged +description: How to check if a contract has been properly staged from the command line +sidebar_position: 4 +--- + +Check to see if a contract has been staged from the Flow CLI + +```shell +flow migrate is_staged +``` + +## Example Usage + +``` +> flow migrate is_staged HelloWorld --network=testnet + +Attempts to confirm if the contract has been staged on the Testnet network. + +``` + +## Arguments + +### Contract Name + +- Name: `contract_name` +- Valid Input: Existing contract name in `flow.json`. diff --git a/docs/tools/flow-cli/migrate/migrate-list-staged-contracts.md b/docs/tools/flow-cli/migrate/migrate-list-staged-contracts.md new file mode 100644 index 0000000000..a314398e12 --- /dev/null +++ b/docs/tools/flow-cli/migrate/migrate-list-staged-contracts.md @@ -0,0 +1,20 @@ +--- +title: List staged Cadence 1.0 Contracts +description: How to list staged Cadence 1.0 Contracts from the command line +sidebar_position: 3 +--- + +Lists all Cadence 1.0 supported contracts that are staged from the Flow CLI. + +```shell +flow migrate list-staged +``` + +## Example Usage + +``` +> flow migrate list-staged --network=testnet + +Lists all staged contracts from the Testnet network. + +``` diff --git a/docs/tools/flow-cli/migrate/migrate-stage-contract.md b/docs/tools/flow-cli/migrate/migrate-stage-contract.md new file mode 100644 index 0000000000..3e6de92be6 --- /dev/null +++ b/docs/tools/flow-cli/migrate/migrate-stage-contract.md @@ -0,0 +1,27 @@ +--- +title: Staging a 1.0 Contract +description: How to stage a Cadence 1.0 supported Contract from the command line +sidebar_position: 1 +--- + +Stage a Cadence 1.0 supported contract project using the Flow CLI. + +```shell +flow migrate stage-contract +``` + +## Example Usage + +``` +> flow migrate stage-contract HelloWorld --network=testnet + +Attempts to the stage the contract `HelloWorld` onto the Testnet network. + +``` + +## Arguments + +### Contract Name + +- Name: `contract_name` +- Valid Input: Existing contract name in `flow.json`. diff --git a/docs/tools/flow-cli/migrate/migrate-unstage-contract.md b/docs/tools/flow-cli/migrate/migrate-unstage-contract.md new file mode 100644 index 0000000000..05a605ac7f --- /dev/null +++ b/docs/tools/flow-cli/migrate/migrate-unstage-contract.md @@ -0,0 +1,27 @@ +--- +title: Unstaging a 1.0 Contract +description: How to unstage a Cadence 1.0 supported Contract from the command line +sidebar_position: 2 +--- + +Unstage a Cadence 1.0 supported contract project using the Flow CLI. + +```shell +flow migrate unstage-contract +``` + +## Example Usage + +``` +> flow migrate unstage-contract HelloWorld --network=testnet + +Attempts to the unstage the contract `HelloWorld` from the Testnet network. + +``` + +## Arguments + +### Contract Name + +- Name: `contract_name` +- Valid Input: Existing contract name in `flow.json`.