Giter Club home page Giter Club logo

dweb-pages-cli's Introduction

Dweb Pages CLI

Hero image

Install

All binaries can be found at our GitHub Release Page, but you can also use our install script to install or update the tool.

curl https://pages.dweb.party | sh

If you don't have root privileges, add sudo in front of the sh command.

Usage

Initialize a new project

To start a new project simply type:

dweb-pages init

This will guide you through the setup process. The tool will then automatically create a new subdirectory called .dweb-pages. This is the place, where all settings and files related to Dweb Pages are stored.

Add tags

The versioning system of Dweb Pages is inspired by Git. Like there, you can create multiple "branches" and "commits".

To add a new version run the following command:

dweb-pages add -t default -t main/latest -t main/v2

For each deployment you can add as much tags, as you want.

If you want to add a tag retrospectively, enter the versions CID as an argument. This will prevent dweb-pages from fetching the directory.

Remove tags

dweb-pages rm -t main/v2

Special Tags

There are some special tags, which you should only use in the following manner:

Tag name Description
default This should point to the latest production build of your app.
<branch-name>/latest latest represents the latest version of a branch.

Please keep in mind, that you don't have to follow this rules. However to be compatible with extending services and further features, it's highly recommended.

Extended features

Postprocessing script

Each time the CID changes, dweb-pages calls the .dweb-pages/then.sh script (if it exists).

This can be used to update a remote/local pin or change a DNS record.

Inside the then.sh script you can access the currentCID environment variable with the latest CID of the project repo.

Use cases

  • Personal blog
  • Project documentation
  • App developement

... and many more

dweb-pages-cli's People

Contributors

alexanderschau avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.