Initializing CLI

This page teaches you initialises Odyssey and creates a config.json file.

1. [CLI] Enter the following command to initialize the Odyssey CLI:

odyssey init

Note: If you run into a permission denied error, please refer to FAQ

1. [CLI] Answer all the following questions which are prompted to complete Odyssey Initialisation step. These questions will be prompted one by one.

Note: If you make any mistakes in the process of inputting in data, you should press ‘Control + C’ to reset the entire step.

Note: The time inputted needs to be in the exact format as shown. The timezone is in UTC 00:00.

? Enter private key:
? Enter network (mainnet/testnet/random): 
? Do you need to randomize traits: (Y/N)
? Is Reveal required for this collection: (Y/N)
? Enter Arweave keyfile (e.g tHW3GofkxahZd2eDXBIo_oDIchmPmqWB7yWI3xsRfd0.json): tHW3GofkxahZd2eDXBIo_oDIchmPmqWB7yWI3xsRfd0.json
? Enter collection name: BAYC
? Enter collection description: Bored Ape Yellow Club
? Enter collection cover image URL: https://arweave.net/<transaction id>
? Enter collection size: 1000
? Enter royalty numerator (if royalty is 5%, key 5 as numerator): 5
? Enter royalty denominator (if royalty is 5%, key 100 as denominator): 100

For the following question, input the number of additional phases required. The number of times you would have to input the Phase start/end times would then depend on your answer.

The Public mint start/end time would then be inputted at the very end.

? How many additional phases do you require? (0 min - 4 max): 

[If the answer to the above question is 1, then the following should appear in the CLI:]
? Enter Phase 1 start time (e.g 2024-03-21T04:00:00Z): 2024-03-21T04:00:00Z
? Enter Phase 1  end time (e.g 2024-03-21T04:00:00Z): 2024-03-21T04:00:00Z
? Enter Phase 1  mint fee in APT (enter 0.1 if mint fee is 0.1 APT): 0.2

[If the answer to the above question is 4, then the following should appear in the CLI:]
? Enter Phase 1 start time (e.g 2024-03-21T04:00:00Z): 2024-03-21T04:00:00Z
? Enter Phase 1  end time (e.g 2024-03-21T04:00:00Z): 2024-03-21T04:00:00Z
? Enter Phase 1  mint fee in APT (enter 0.1 if mint fee is 0.1 APT): 0.2
? Enter Phase 2 start time (e.g 2024-03-21T04:00:00Z): 2024-03-21T04:00:00Z
? Enter Phase 2 end time (e.g 2024-03-21T04:00:00Z): 2024-03-21T04:00:00Z
? Enter Phase 2 mint fee in APT (enter 0.1 if mint fee is 0.1 APT): 0.2
? Enter Phase 3 start time (e.g 2024-03-21T04:00:00Z): 2024-03-21T04:00:00Z
? Enter Phase 3  end time (e.g 2024-03-21T04:00:00Z): 2024-03-21T04:00:00Z
? Enter Phase 3  mint fee in APT (enter 0.1 if mint fee is 0.1 APT): 0.2
? Enter Phase 4  start time (e.g 2024-03-21T04:00:00Z): 2024-03-21T04:00:00Z
? Enter Phase 4  end time (e.g 2024-03-21T04:00:00Z): 2024-03-21T04:00:00Z
? Enter Phase 4  mint fee in APT (enter 0.1 if mint fee is 0.1 APT): 0.2

? Enter public sales start time (e.g 2024-03-21T04:00:00Z): 2024-03-21T04:00:00Z
? Enter public sales end time (e.g 2024-03-21T04:00:00Z): 2024-03-21T04:00:00Z
? Enter public sales mint fee in APT (enter 0.1 if mint fee is 0.1 APT): 0.3

Should you wish to skip any steps (eg. collection cover image), simply press ‘Enter’ and move on to the following field.

Note: Every time you run odyssey init, the CLI is attempting to create a config.json file for you.

1. After initialization, the following config.json file will be created in the root folder. The following is an example of the config.json file with 3 additional mint phases:

{
  "private_key": "0x000CreatorPrivateKey",
  "network": "random",
  "random_trait": true,
  "odyssey_name": "Odyssey Name",
  "storage": {
    "arweave": {
      "IPFSPath": "https://arweave.net",
      "keyfilePath": "/CreatoKeyFiler.json"
    }
  },
  "collection": {
    "collection_name": "Collection name",
    "description": "Collection description",
    "cover": "https://arweave.net/1234567890",
    "collection_size": 100,
    "royalty_numerator": 5,
    "royalty_denominator": 100,
    "additional_phases": 3,
    "presales_phases": [
      {
        "start_time": "2024-11-04T07:15:00Z",
        "end_time": "2024-11-04T02:22:00Z",
        "mint_fee": 0,
        "name_phase": "Phase1"
      },
      {
        "start_time": "2024-11-01T02:22:00Z",
        "end_time": "2024-11-01T02:25:00Z",
        "mint_fee": 0,
        "name_phase": "Phase2"
      },
      {
        "start_time": "2024-11-01T02:26:00Z",
        "end_time": "2024-11-01T02:30:00Z",
        "mint_fee": 0,
        "name_phase": "Phase3"
      }
    ],
    "public_sales_start_time": "2024-11-01T02:31:00Z",
    "public_sales_end_time": "2024-11-01T08:35:00Z",
    "public_sales_mint_fee": 0,
    "public_max_mint": 0,
    "asset_dir": "/assets",
    "whitelist_dir": "/whitelist/"
  },
  "base_token_uri": "https://arweave.net/1234567890"
  }

Note:

• Should you feel like making any edits (eg. change collection name, change presale start time etc.) you can edit it directly in this json file. Please make sure that while editing, you are adhering to the correct formats, else errors will be faced.

• For “asset_dir”, ensure that path points to the assets folder created in your machine

• For “whitelist_dir_file”, refer to Whitelisting.

End of page

---