# @algo-builder/algob > A framework for building and testing Algorand smart contracts and dapps. Latest version **7.0.0** (published 2022-12-07) · Apache-2.0 license · 0 weekly downloads ## Install ```sh npm install @algo-builder/algob pnpm add @algo-builder/algob yarn add @algo-builder/algob bun add @algo-builder/algob ``` Provides the commands `0`, `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `13`, `14`, `15`, `16`, `17`, `18`, `19`, `20`, `21`, `22`, `23`, `24`. ## Health **Score 25/100 (F)** — status: abandoned. Positive: has types; no vulnerabilities; high quality score. Warnings: low downloads; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 7.0.0 | | Published | 2022-12-07 | | First published | 2021-03-17 | | Weekly downloads | 0 | | License | Apache-2.0 | | TypeScript types | bundled | | Module format | CommonJS | | Node | >=14.11.0 | | Dependencies | 20 | | Unpacked size | 701.8 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 128 | | Author | Robert Zaremba (https://zaremba.ch) | | Maintainers | robert.zaremba | | Keywords | smart-contracts, blockchain, builder, algorand, dapps, javascript, tooling, task-runner | ## Links - npm: https://www.npmjs.com/package/@algo-builder/algob - Repository: https://github.com/scale-it/algo-builder.git - Homepage: https://algobuilder.dev - npm.io page: https://npm.io/package/@algo-builder/algob ## Dependencies (20) - [tmp](https://npm.io/package/tmp.md) ^0.2.1 - [zod](https://npm.io/package/zod.md) ^3.19.1 - [glob](https://npm.io/package/glob.md) ^7.2.0 - [yaml](https://npm.io/package/yaml.md) ^1.10.2 - [chalk](https://npm.io/package/chalk.md) ^4.1.2 - [debug](https://npm.io/package/debug.md) ^4.3.4 - [mocha](https://npm.io/package/mocha.md) ^10.1.0 - [semver](https://npm.io/package/semver.md) ^7.3.8 - [algosdk](https://npm.io/package/algosdk.md) ^1.24.0 - [enquirer](https://npm.io/package/enquirer.md) ^2.3.6 - [fs-extra](https://npm.io/package/fs-extra.md) ^10.1.0 - [deepmerge](https://npm.io/package/deepmerge.md) ^4.2.2 - [deep-equal](https://npm.io/package/deep-equal.md) ^2.0.5 - [murmurhash](https://npm.io/package/murmurhash.md) ^2.0.1 - [findup-sync](https://npm.io/package/findup-sync.md) ^5.0.0 - [@algo-builder/web](https://npm.io/package/@algo-builder/web.md) 7.0.0 - [download-git-repo](https://npm.io/package/download-git-repo.md) ^3.0.2 - [source-map-support](https://npm.io/package/source-map-support.md) ^0.5.21 - [@algo-builder/runtime](https://npm.io/package/@algo-builder/runtime.md) 7.0.0 - [is-installed-globally](https://npm.io/package/is-installed-globally.md) ^0.4.0 ## Alternatives - [localforage](https://npm.io/package/localforage.md) — 6.2M weekly downloads - [localforage-observable](https://npm.io/package/localforage-observable.md) — 30.8K weekly downloads - [@y/y](https://npm.io/package/@y/y.md) — 30.1K weekly downloads - [@metaobjectsdev/render](https://npm.io/package/@metaobjectsdev/render.md) — 3.5K weekly downloads - [@ledgerhq/coin-algorand](https://npm.io/package/@ledgerhq/coin-algorand.md) — 1.1K weekly downloads ## Recent versions - 7.0.0 (latest) — 2022-12-07 - 6.0.0 — 2022-11-04 - 5.0.1 — 2022-07-11 - 5.0.0 — 2022-07-08 - 4.0.0 — 2022-05-24 - 3.2.0 — 2022-02-03 - 3.1.0 — 2022-01-25 - 3.0.0 — 2021-12-21 - 2.1.0 — 2021-10-22 - 2.0.1 — 2021-10-18 - 2.0.0 — 2021-09-30 - 1.2.1 — 2021-09-15 - 1.2.0 — 2021-08-09 - 1.1.2 — 2021-07-16 - 1.1.1 — 2021-07-12 - … 6 more at https://npm.io/package/@algo-builder/algob/versions ## README # [Algo Builder](https://algobuilder.dev/) Algob is the CLI (Command Line Interface) for Algo Builder. Think about it as an Ethereum Truffle but for Algorand projects. This package provides a variety of high level functions like, `executeTx`, `mkTxParams`, `Deployer`, etc. These functions help in making the development phase of algorand applications easier by acting as a middleware between the developer and `algosdk`. Please read the main [README](https://github.com/scale-it/algo-builder/blob/master/README.md) file for details about the project and `algob`. This file provides a development description about the `algob` package. ## How to use the API docs? The best way to find a type, function or something related to a use case is by using the **search field** at the **top** of this page. ## Important links - [Home Page](https://algobuilder.dev/) - [Algob API Docs](https://algobuilder.dev/api/algob/index.html) - [User Docs](https://algobuilder.dev/guide/README) ## Using algob `algob` can be included as a library using `yarn add @algo-builder/algob` and then import it using `import * from '@algo-builder/algob'` or can be run from command line as described in the project [README](https://github.com/scale-it/algo-builder/blob/master/README.md) file. For a webapps, you should use [@algo-builder/web](https://algobuilder.dev/api/web/index.html) package, which is used by algob. ### Command line usage `algob` always starts for checking and loading `algob.config.js` file. The config file will be generated (in the current directory) if not present in the project tree. Help `algob help` View version `algob --version` Launch a node project console `algob console` ## Contributing When working on `algob`, we use CLI directly from the build directory using the following command: yarn run algob:dev It will create a `project-dev` directory as a copy of the template project (`sample-project`). In that directory you should update the `config.algob.js`. The `algob:dev` command will run all `algob` in that directory. Also, it my be helpful to link the binary: yarn link You can run another alogb cli on dev project by following pattern `yarn algob:dev:cmd `. e.g: yarn algob:dev:cmd test yarn algob:dev:cmd deploy --- _Source: https://npm.io/package/@algo-builder/algob · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._