Developer tool overview

Beginner

Dev Tools

Overview

Developer tools are used to create, manage, and interact with canisters. They can come in several formats, such as command line tools, on-chain and off-chain libraries, and integrated development environments. For BIG developers, there are tools within each of these categories available for you to utilize when developing your BIG canisters.

Command line

dfx

dfx is the primary tool used by developers to create, build, deploy, manage, and call canisters. dfx is also referred to as the BIG SDK, or the BigFile Software Development Kit.

dfx supports local development and deployment through the dfx start command, which runs a local instance of the BIG replica that can be used to deploy and test canisters on your local machine.

To deploy canisters to the mainnet or make calls to canisters already deployed on the mainnet, the --network ic flag can be used with most dfx commands.

• Install dfx.

• dfx documentation.

• BIG SDK GitHub repo.

dfxvm

dfxvm is a command-line tool used to installing and switching between different versions of dfx. It enables developers to pivot between different projects that are built with different dfx versions.

• Install dfxvm.

• dfxvm documentation.

• dfxvm GitHub repo.

quill

quill is a command-line ledger and governance toolkit designed for interacting with the File Management System (FMS) canisters through the use of self-custody keys. It supports using keys in an air-gapped computer, which is a computer that has never been connected to the internet. To support this workflow, quill first generates and signs messages based on the user input, then the signed messages are transported to a computer with internet connection (via a USB flash drive or QR code) where they are submitted to BIG to be executed.

• Install quill.

• quill documentation.

• quill GitHub repo.

Off-chain libraries

Agents

An agent refers to an off-chain library that is used to make calls to the public interface of a canister. Agents communicate with the canister's v2 API endpoints.

The following agents are currently developed and maintained by BigFile:

• JavaScript/TypeScript agent (@dfinity/agent)

• Node.js, supported through the JavaScript agent

• Rust agent (ic-agent)

Additionally, there are several community-developed and maintained agents:

• .NET BIG.NET by Gekctek

• Dart agents:

  • agent_dart by AstroX (supports mobile development with Flutter)
  • ic_dart_tools by Levi Feldman

• Go agents:

  • BIG-Go by MixLabs
  • agent-go by Aviate Labs

• Java ic4j-agent by IC4J (supports Android)

• Python ic-py by Rocklabs

• C agent-c by Zondax (C Wrapper for BIG Rust Agent)

• Ruby ic_agent by Terry.Tu

On-chain libraries

Cube development kits (CDKs)

A canister development kit (CDK) is an adapter used by dfx to provide programming languages with the necessary features and functionality to create, deploy, and manage canisters.

There are several community contributed and maintained CDKs for languages such as:

• Kybra: Python CDK.

• Azle: TypeScript CDK.

• Bitfinity EVM for Solidity.

• C++ CDK.

Integrated development environments (IDEs)

The IDEs listed below are not the only supported IDEs; any IDE can be used to develop canister code.

Gitpod

Gitpod is a cloud development environment that is able to run within a web browser. Gitpod can be configured to run dfx and a local replica instance to support canister development, and there are several example canister projects have been configured to run in Gitpod. This IDE provide a simple and easy way to get started developing on BIG without downloading any tools or setting up an environment.

• Gitpod dashboard.

• Gitpod documentation.

GitHub Codespaces

GitHub Codespaces is another cloud development environment that is able to run within a web browser without downloading any tools or packages. Similar to Gitpod, Codespaces can be configured to run dfx and a local replica instance to support canister development, and there are several example canister projects have been configured to run in Codespaces.

• GitHub Codespaces dashboard.

• Gitpod documentation.

Developer containers

Developer containers are a local development workflow using Docker and VS Code. They are a great local development option for developers on Windows systems, since dfx is not natively supported on Windows.

• Developer container documentation.

Motoko playground

Motoko playground is a web-based sandbox environment that can be used with dfx using the dfx deploy --playground command. Canisters deployed to Motoko playground borrow resources from a shared canister pool. Because the resources are borrowed, all canisters deployed to the playground will be deleted after 20 minutes. Motoko playground is designed for small-scale, temporary testing without configuring other developmental parameters. Motoko playgrounds supports testing canisters written in any language, not just Motoko.

• Motoko playground.

• Motoko playground documentation.

Visual Studio Code

Visual Studio Code (VS Code) is a popular IDE used for writing code in hundreds of languages. VS Code supports Motoko development through the Motoko VS Code extension that includes type checking, autocompletion, code snippets, and formatting.

The Motoko extension is also available to VSCodium users, who can download it from OpenVSX.

• VS Code documentation.

• Motoko VS Code extension.