website/docs/setup-toolchain.mdx
import HeaderLabel from '@site/src/components/Docs/HeaderLabel'; import NextSteps from '@site/src/components/NextSteps'; import LangPartials from '@site/src/components/LangPartials';
<HeaderLabel text="5 min" />One of moon's most powerful features is the toolchain, which automatically manages, downloads, and installs Node.js and other languages behind the scenes using proto. It also enables advanced functionality for task running based on the platform (language and environment combination) it runs in.
The toolchain is configured with .moon/toolchains.*.
:::tip
Change the language dropdown at the top right to switch the examples!
:::
For more information on the toolchain, our tier based support, and how languages integrate into moon, refer to the official "how it works" language guide and the toolchain concept documentation!
:::info
The toolchain is optional but helps to solve an array of issues that developers face in their day-to-day.
:::
By default all tasks run through the
system toolchain and inherit no special
functionality. If you want to take advantage of this functionality, like dependency hashing, package
shorthand execution, and lockfile management, you'll need to enable the toolchain in
.moon/toolchains.*. Otherwise, you can skip to the
create a task guide.
Begin by declaring the necessary configuration block, even if an empty object! This configuration
can also be injected using the moon toolchain add <toolchain> command
(doesn't support all languages).
import Tier2Bun from './partials/setup-toolchain/bun/tier2.mdx'; import Tier2Deno from './partials/setup-toolchain/deno/tier2.mdx'; import Tier2Go from './partials/setup-toolchain/go/tier2.mdx'; import Tier2Node from './partials/setup-toolchain/node/tier2.mdx'; import Tier2PHP from './partials/setup-toolchain/php/tier2.mdx'; import Tier2Python from './partials/setup-toolchain/python/tier2.mdx'; import Tier2Ruby from './partials/setup-toolchain/ruby/tier2.mdx'; import Tier2Rust from './partials/setup-toolchain/rust/tier2.mdx';
<LangPartials> <Tier2Bun key="bun" /> <Tier2Deno key="deno" /> <Tier2Go key="go" /> <Tier2Node key="node" /> <Tier2PHP key="php" /> <Tier2Python key="python" /> <Tier2Ruby key="ruby" /> <Tier2Rust key="rust" /> </LangPartials>Although we've enabled the toolchain, language binaries must exist on PATH for task execution to
function correctly. Continue reading to learn how to automate this flow using tier 3 support.
One of the best features of moon is its integrated toolchain and automatic download and installation of programming languages (when supported), for all developers and machines that moon runs on. This feature solves the following pain points:
PATH.If you have dealt with any of these pain points before and would like to eliminate them for you and
all your developers, you can try enabling moon's tier 3 support for supported tools. This is easily
done by defining the version field for each toolchain.
import Tier3Bun from './partials/setup-toolchain/bun/tier3.mdx'; import Tier3Deno from './partials/setup-toolchain/deno/tier3.mdx'; import Tier3Go from './partials/setup-toolchain/go/tier3.mdx'; import Tier3Node from './partials/setup-toolchain/node/tier3.mdx'; import Tier3PHP from './partials/setup-toolchain/php/tier3.mdx'; import Tier3Python from './partials/setup-toolchain/python/tier3.mdx'; import Tier3Ruby from './partials/setup-toolchain/ruby/tier3.mdx'; import Tier3Rust from './partials/setup-toolchain/rust/tier3.mdx';
<LangPartials> <Tier3Bun key="bun" /> <Tier3Deno key="deno" /> <Tier3Go key="go" /> <Tier3Node key="node" /> <Tier3PHP key="php" /> <Tier3Python key="python" /> <Tier3Ruby key="ruby" /> <Tier3Rust key="rust" /> </LangPartials>When the version field is configured, moon will download and install the tool when a related task
is executed for the first time! It will also set the correct PATH lookups and environment
variables automatically. Amazing right?
<NextSteps links={[ { icon: 'new-task', label: 'Create a task', url: './create-task' }, { icon: 'toolchain-config', label: ( <span> Configure <code>.moon/toolchains.yml</code> further </span> ), url: './config/toolchain', }, { icon: 'toolchain', label: 'Learn about the toolchain', url: './concepts/toolchain' }, ]} />