![\"Spheron\"](\"https://github.com/spheronFdn/sdk/blob/main/.github/assets/logo.svg\"){kind=logo}
\n\n\n\n\n\n
\n🧰 CLI tool for creating and deploying dapps to web3.\n
\n\n \n\n\n\n\n\n![](\"https://img.shields.io/static/v1?label=npm&message=v1.0.4&color=green\")
![](\"https://img.shields.io/static/v1?label=license&message=Apache%202.0&color=red\")
![](\"https://img.shields.io/static/v1?label=community&message=discord&color=blue\")
![](\"https://img.shields.io/twitter/url/https/twitter.com/cloudposse.svg?style=social&label=Follow%20%40SpheronFdn\")
\n\n\n\n
To use Spheron CLI, you need to first install it using the following command:
\n\nsudo npm install -g @spheron/cliOnce you have installed the CLI, you can use the following commands to create and deploy dapps to web3:
\n\n#\nUse spheron create-dapp to create a template project that will easily be deployed on Spheron later.
spheron create-dappspheron init --protocol {protocol} [--project {project_name}] [--path {path}] [--framework {framework}]] \n\n#\nUse spheron init to initialize a new Spheron project. This will create a new spheron.json file in your current path. This spheron.json file is a file describing your project. It will be used for spheron publish command. See more in spheron publish command section.
spheron initspheron init --protocol {protocol} [--project {project_name}] [--path {path}] [--framework {framework}]] \nYou can update this file manually afterwards to change default settings.\n\n***Params options***\n**protocol*** - [arweave/filecoin/ipfs]\n**project** - name (if not provided, path last segment will be taken by default)\n**path** - where is the location of dir/file that you want to upload (default is ./) \n**framework** -[static/react/vue/angular/next/preact/nuxt2/docusaurus/hugo/eleventy/svelte/gatsby/sanity/ionicreact/vite/scully/stencil/brunch/ionicangular] \n\n**Note**: * stands for mandatory (if all of mandatory params are not sent, prompter will be opened)\n#\nUse spheron publish to upload your project configuration described in spheron.json file of your project.
spheron publishUse spheron upload if you want to directly upload your file/directory to the specific protocol without need to setup the project. Using this command expects you to be logged in previously. To do that use spheron login before upload.
spheron uploadspheron upload --path {file_path} --protocol {protocol} [--project {project_name}] [--organization {organizationId}] \n\n\n***Params options***\n**path*** - where is the location of dir/file that you want to upload (default is ./) \n**protocol*** - [arweave/filecoin/ipfs]\n**project** - name (if not provided, path last segment will be taken by default)\n**organization** - you can override organizationId that will be used. By default it will take one that you have received after executing spheron login\n\n**Note**: * stands for mandatory (if all of mandatory params are not sent, prompter will be opened)\n\n# \nUse spheron create-organization if you want to create a new organization. This will set that organization as default and will use it later for upload/publish commands by default. Keep in mind that first time you execute spheron login command, you will get new organization created if you already didn't have one set up.
spheron create-organizationspheron upload --name {organization_name} --username {organization_username} \n\n***Params options***\n**name*** - name of your organization \n**username*** - username represent short name for your organization.\n\n**Note**: * stands for mandatory (if all of mandatory params are not sent, prompter will be opened)\n \n #\n Use spheron login to connect to your Spheron account. This command will allow you to authenticate to Spheron and is mandatory to execute before doing upload or publish commands.
spheron loginspheron login [--github | --gitlab | --bitbucket] \n \n\n## Learn More\n\nYou can learn more about Spheron and Spheron CLI here:\n\n \n\n- [Spheron Discord](https://discord.com/invite/ahxuCtm)\n\n- [Spheron Twitter](https://twitter.com/SpheronFdn)\n","readmeFilename":"README.md","description":"CLI for working on projects and deploying them via Spheron ","keywords":["CLI","Typescript","Badass","IPFS","Filecoin","Arweave","Deploy","Publish"],"author":{"name":"Spheron Team"},"homepage":"https://github.com/spheronFdn/sdk#readme","repository":{"type":"git","url":"git://github.com/spheronFdn/sdk.git"},"bugs":{"url":"https://github.com/spheronFdn/sdk/issues"}}