Package Health Score

76 / 100

security
Security review needed
popularity
Small
maintenance
Healthy
community
Active

Explore Similar Packages

Security

Security review needed

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
4.2.0	\|	10/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
4.1.0	\|	08/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
3.0.0	\|	10/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.128.0	\|	05/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.127.4	\|	05/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Small

Weekly Downloads (1,174)

GitHub Stars: 60
Forks: 20
Contributors: 80

Direct Usage Popularity

The npm package vtex receives a total of 1,174 downloads a week. As such, we scored vtex popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package vtex, we found that it has been starred 60 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Active

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: No
Contributors: 80
Funding: No

With more than 10 contributors for the vtex repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like vtex is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 1
Open PR: 26
Last Release: 2 months ago
Last Commit: 2 months ago

Further analysis of the maintenance status of vtex based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that vtex demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=10

Age: 10 years
Dependencies: 76 Direct
Versions: 739
Install Size: 476 kB
Dist-tags: 4
# of Files: 343
Maintainers: 95
TS Typings: No

vtex has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Not sure how to use vtex?

To help you get started, we've collected the most common ways that vtex is being used within popular public projects.

vtex-apps / store-components / react / components / SKUSelector / components / ErrorMessage.tsx View on Github

function ErrorMessage() {
  const handles = useCssHandles(CSS_HANDLES)
  const className = `${handles.errorMessage} c-danger`

  return (
    
      {message =&gt; (
        &lt;&gt;{' '}{/* this space is necessary */}
          <span>
            {message}
          </span>
        
      )}
    
  )
}

View more ways to use vtex

VTEX Toolbelt

The CLI that offers all you need to start using the VTEX IO platform efficiently.

Summary

How do we empower you?

VTEX Toolbelt is a command-line program that gives you access to all of the features in the VTEX platform and increases your productivity, allowing you to:

Manage your apps quickly: List, install and uninstall available apps in your account;
Work safely on your personal environments: List, create and remove workspaces;
Easily ship changes to your final user: Promote a workspace to master, making it public in your account URL;
See what you are creating in real time: Develop new apps in link mode, using automatic synchronization;
Go live from the command line: Publish apps to the VTEX App Store.

Getting started: Installing the VTEX Toolbelt

To use the VTEX Toolbelt, you'll need to install other engines that will also be useful when developing for VTEX.

Node.js to run the tool

Install Node.js here: Toolbelt is written in Typescript and designed to run on Node.js. (Node is the runtime that executes the JS and allows our tool to run and work at your computer)
Install yarn here: yarn is a way to manage your code, organize content in packages that you can download, share and... install, just like our CLI 😃

Now do you have Node.js and Yarn? Let's install the Toolbelt.

Installing the Toolbelt with yarn

yarn powers app development to React, Node and VTEX IO! Install the Toolbelt using yarn and start working with us generating automatically all the files you'll need to create apps in the future. To install it, run:

yarn global add vtex

Alternative installation method using npm

You can install using `npm`. But remember, if in the future you want to develop a VTEX IO app, you'll need to install `yarn`

To install with npm, run:

npm install -g vtex

Using the CLI

After installation, run vtex to see our commands and what each one of them does.

Or, check all our commands here

$ vtex
  Welcome to VTEX I/O
  Login with vtex login 

  Usage: vtex  [options]

  Commands:

    add                Add app(s) to the manifest dependencies
    deprecate [app]         Deprecate app(s)
    init                    Create basic files and folders for your VTEX app
    install [app]           Install an app (defaults to the app in the current directory)
    link                    Start a development session for this app
    setup                   Setup your development environment (configure tsconfig and tslint, run yarn)
    list                    List your installed VTEX apps
    logs                    Show apps production logs
    login                   Log into a VTEX account
    logout                  Logout of the current VTEX account
    promote                 Promote this workspace to master
    publish [path]          Publish the current app or a path containing an app
    switch         Switch to another VTEX account
    test                    Run your VTEX app unit tests
    uninstall [app]         Uninstall an app (defaults to the app in the current directory)
    unlink [app]            Unlink an app on the current directory or a specified one
    update                  Update all installed apps to the latest version
    use               Use a workspace to perform operations
    whoami                  See your credentials current status

    browse [endpoint]       Browse an endpoint of the store under development

    config get                  Gets the current value for the requested configuration
    config set           Sets the current value for the given configuration

    deps list                              List your workspace dependencies
    deps update [app]                      Update all workspace dependencies or a specific app@version
    deps diff [workspace1] [workspace2]    Show dependencies difference between two workspaces

    infra install      Install a service
    infra list [name]        List installed services
    infra update             Update all installed services

    local manifest    Generate manifest from package.json
    local package     Generate package.json from manifest
    local account     Show current account and copy it to clipboard
    local workspace   Show current workspace and copy it to clipboard
    local token       Show user's auth token and copy it to clipboard

    port react       Convert your app from React 0.x to React 2.x

    release [releaseType/Version] [tagName]          Bump app version, commit and push to remote (git only)

    settings  [fields]                     Get app settings
    settings set            Set a value
    settings unset                 Unset a value

    redirects import       Import redirects for the current account and workspace
    redirects export       Export all redirects in the current account and workspace
    redirects delete       Delete redirects in the current account and workspace

    url                               Prints base URL for current account, workspace and account

    workspace                         Alias for vtex workspace info
    workspace create            Create a new workspace with this name
    workspace delete            Delete a single or various workspaces
    workspace info                    Display information about the current workspace
    workspace list                    List workspaces on this account
    workspace promote                 Promote this workspace to master
    workspace reset [name]            Delete and create a workspace
    workspace use               Use a workspace to perform operations

  Options:

    -h, --help  show help information

Second step: log into your VTEX account

Start by using vtex login to receive your credentials and be able to access other features. Simply type this command and follow the instructions.

Having trouble with login? Follow these steps

You can use vtex login to login with your VTEX ID credentials or vtex logout if you're already logged in and want to change credentials.

When logging in, you will be asked for 3 things:

The account name of the store you wish to work on, that would be your company's or client's account name;
Your VTEX ID email, the one you received access to work with VTEX.
Your VTEX ID password, the one you chose when creating your user.

If you wish to work on another account, run vtex switch specifying the account you want to move to.

> 😉 Note that link and publish implicitly checks if you're logged, and if you're not, it asks your credentials before proceeding.

To develop locally: use vtex link

When you log in to an account, you can create your own workspaces to work on your ideas or see what is in production. To do so:

On an app directory, run vtex link and click on or copy the provided URL into your browser;
Now on, VTEX Toolbelt will monitor your files for change and sync them with what you see automatically.

Know more about local development with Toolbelt

Toolbelt will upload all your app files to the developer environment, print an URL for your use, and watch for any changes you make to the files, which will be automatically synchronized.

Wanna know something cool? You can customize your prompt

You can configure your terminal prompt to display relevant information about your current context, like which account you're logged into and which workspace you are currently using.

Just like knowing which git branch you're currently in, having this info in your prompt will help you avoid mistakes and be faster when using VTEX IO.

How to do so?

`bash` users

If you are a bash user you can start customizing your command prompt by running the following command:

echo "source $(npm root -g)/vtex/plugins/bash/vtex.bash" &gt;&gt; ~/.bashrc
echo "source $(npm root -g)/vtex/plugins/bash/prompt.bash" &gt;&gt; ~/.bashrc

> 😉 For fine grained control, use only the first script and add __vtex_ps1 manually to your prompt.

`fish` users

If you want a pretty, ready-made Git + VTEX prompt you can copy plugins/fish/fish_prompt.fish to the ~/.config/fish/functions folder. To see the changes, simply restart your shell by typing fish.

cp (npm root -g)/vtex/plugins/fish/fish_prompt.fish ~/.config/fish/functions/
fish

> 💡 If you installed Toolbelt using yarn, you should replace (npm root -g) with (yarn global dir).

Frequently Asked Questions

How do I ignore specific files or directories in my app so that they are not uploaded?

Create a .vtexignore file containing, on each line, paths you wish to ignore. If no .vtexignore is found, your .gitignore file is used instead.

Is there another way to customize the prompt?

You can do so by adding the vtex_get_account and vtex_get_workspace commands to your PS1 environment variable the way it pleases you.

Contributing

Follow the steps on contributing.md.

License

MIT

Tell us what you think about Toolbelt

📡 We are always looking for ways to improve your experience. Please, send us feedback about the VTEX Toolbelt here.

vtex dependencies

ws ajv koa opn ora tar diff open yarn boxen chalk ramda tslib globby is-wsl moment numbro semver co-body graphql js-yaml prompts request winston archiver bluebird chokidar debounce enquirer fs-extra @vtex/api cli-table csvtojson is-docker cli-table2 clipboardy get-stream any-promise async-retry configstore detect-port eventsource semver-diff ansi-escapes jsonwebtoken randomstring unzip-stream @oclif/config indent-string node-notifier ramda-adjunct @oclif/command latest-version prompt-confirm proper-lockfile qrcode-terminal update-notifier extendable-error v8-compile-cache @yarnpkg/lockfile winston-transport @oclif/plugin-help supports-hyperlinks @vtex/cli-plugin-deps @vtex/cli-plugin-abtest @vtex/cli-plugin-deploy @vtex/cli-plugin-whoami @vtex/node-error-report pipe-streams-to-promise @vtex/cli-plugin-edition @vtex/cli-plugin-plugins child-process-es6-promise @vtex/cli-plugin-workspace @vtex/cli-plugin-autoupdate @vtex/toolbelt-message-renderer @tiagonapoli/oclif-plugin-spaced-commands

FAQs

What is vtex?

The platform for e-commerce apps. Visit Snyk Advisor to see a full health score report for vtex, including popularity, security, maintenance & community analysis.

Is vtex popular?

The npm package vtex receives a total of 1,174 weekly downloads. As such, vtex popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is vtex well maintained?

We found that vtex demonstrated a healthy version release cadence and project activity. It has a community of 80 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is vtex safe to use?

While scanning the latest version of vtex, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 30 December-2024, at 08:28 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (1,174)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Not sure how to use vtex?

VTEX Toolbelt

Summary

How do we empower you?

Getting started: Installing the VTEX Toolbelt

Node.js to run the tool

Installing the Toolbelt with yarn

Using the CLI

Second step: log into your VTEX account

To develop locally: use vtex link

Wanna know something cool? You can customize your prompt

How to do so?

bash users

fish users

Frequently Asked Questions

Contributing

License

Tell us what you think about Toolbelt

vtex dependencies

vtex development dependencies

FAQs

What is vtex?

Is vtex popular?

Is vtex well maintained?

Is vtex safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues

`bash` users

`fish` users