Skip to content

Commit

Permalink
[Docs] Update TS installation docs to use pnpm exec instead of depr…
Browse files Browse the repository at this point in the history
…ecated `pnpx` (#1144)

[`pnpx` has been deprecated](pnpm/pnpm#3652) in
favor of `pnpm exec` and `pnpm dlx`.

This PR modifies the installation docs for Typescript / pnpm to use
`pnpm exec` instead of `pnpx`. `exec` is favored over `dlx` in this
instance since the `baml-cli` command is installed in the local
`node_modules/.bin`.
<!-- ELLIPSIS_HIDDEN -->

----

> [!IMPORTANT]
> Update TypeScript installation docs to use `pnpm exec` instead of
deprecated `pnpx`.
> 
>   - **Documentation**:
> - Update `typescript.mdx` to use `pnpm exec baml-cli init` instead of
deprecated `pnpx baml-cli init`.
> 
> <sup>This description was created by </sup>[<img alt="Ellipsis"
src="https://img.shields.io/badge/Ellipsis-blue?color=175173">](https://www.ellipsis.dev?ref=BoundaryML%2Fbaml&utm_source=github&utm_medium=referral)<sup>
for 41c0fb9. It will automatically
update as commits are pushed.</sup>

<!-- ELLIPSIS_HIDDEN -->

Co-authored-by: hellovai <[email protected]>
  • Loading branch information
mbokinala and hellovai authored Nov 26, 2024
1 parent 03d9475 commit 56194b8
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions fern/01-guide/02-languages/typescript.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ To set up BAML with Typescript do the following:
```

```bash pnpm
pnpx baml-cli init
pnpm exec baml-cli init
```

```bash yarn
Expand Down Expand Up @@ -120,4 +120,4 @@ To set up BAML with Typescript do the following:

```
</CodeBlocks>
</Steps>
</Steps>

0 comments on commit 56194b8

Please sign in to comment.