@pageshare/cli

This package provides commands to publish local frontend web app into PageShare.dev.

How to use

Build your frontend web app and execute:

npx @pageshare/cli ./dist

or

npm install -g @pageshare/cli
pageshare ./dist

Replace ./dist with a path to your built frontend project (must include index.html file).

In order to finish the process, you need to create an account on PageShare.dev and provide your personal access token in a command as --access-token ... or as an environment variable PAGESHARE_ACCESS_TOKEN. Copy your access token from https://www.pageshare.dev/user/settings.

Parameters

• --version - prints script version
• --access-token - your personal access token copied from https://www.pageshare.dev/user/settings; can be also stored as an environment variable PAGESHARE_ACCESS_TOKEN
• --dry - opens a browser and doesn't upload the page; useful for testing configuration
• --verbose - turns on verbose logging
• --ci - alias for --verbose
• --config - path to the config file; pageshare.config.(ts|cjs|js) by default; see https://github.com/PageShare/pageshare/blob/master/packages/cli/src/types.ts for documentation
• --mock-server - path to the node mock-server directory or index file; learn more reading https://www.pageshare.dev/blog/how-to-use-mock-server
• --git-remote-url - URL to your git remote as it shows in git remote -v, needed for integrations; by default it uses git from local directory
• --git-commit - hash of the latest git commit, needed for integrations; by default it uses git from local directory
• --force - continue process by ignoring warnings

Integration with GitHub

Install GitHub app on https://github.com/apps/pageshare/installations/new.

Each publish will create a commit status and Pull Request comment.

Use with GitHub actions

We provide custom GitHub action at https://github.com/PageShare/gh-action-publish.

Use in CI/CD

This package requires additional system dependencies to run Chromium browser.

Check our Dockerfile or use it directly from docker hub (recommended):

docker run --rm -v "$(pwd)/dist:/usr/share/pageshare/dist" pageshare/cli /usr/share/pageshare/dist