botway

command module
v0.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 30, 2022 License: MIT Imports: 13 Imported by: 0

README

Botway

🤖 Generate, build, handle and deploy your own bot with your favorite language, for Discord, or Telegram, or Slack, or even Twitch.

With botway, you can focus on your bot's logic and don't worry about the infrastructure. and we will take care of the rest.

Botway uses Railway and Render to host your bot code and database.

https://user-images.githubusercontent.com/64256993/175816610-70160d02-8324-4a50-ac4d-78e0993cd91d.mp4

Requirements

Installation ⬇

NPM

# npm
npm i -g botway

# yarn
yarn global add botway

# pnpm
pnpm add -g botway

Using script

  • Shell
curl -sL https://bit.ly/botway | bash
  • PowerShell
irm https://bit.ly/bw-win | iex

then restart your powershell

Homebrew

brew install abdfnx/tap/botway

Scoop

scoop bucket add botway https://github.com/abdfnx/botway
scoop install botway

Usage

  • Initialize ~/.botway

    botway init
    
  • Authenticate with your favorite host service

    # railway
    botway login railway
    
    # render
    botway login render
    
  • Open Botway TUI

    botway
    
  • Create a new botway project

    botway new <project-name>
    
  • Manage your bot tokens

    botway tokens <command> [flags] <project-name>
    
  • Start running your bot

    # Under the project directory
    botway start
    
  • Manage your bot database

    # Under the project directory
    botway database <command>
    
  • Deploy and upload project from the current directory

    # Under the project directory
    botway deploy
    
  • Execute a local command using variables from the active environment

    # Under the project directory
    botway exec <command>
    

Roadmap

You can see the Roadmap

Keyboard shortcuts

  • Up: Move up
  • Down: Move down
  • Tab: Switch windows
  • Ctrl+O: Open bot project at Host Service
  • Esc: Reset
  • Ctrl+Q: Quit

Technologies Used in Botway

Special thanks ❤

Thanks to @charmbracelet for their awesome TUI libraries 🏗.

Also thanks to @railwayapp and @renderinc for their amazing cloud and host services ☁️.

License

botway is licensed under the terms of MIT license.

Star History

Star History Chart

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
cmd
app
internal
dashboard
forked from: https://github.com/charmbracelet/bubbles/blob/master/paginator/paginator.go
forked from: https://github.com/charmbracelet/bubbles/blob/master/paginator/paginator.go
dashboard/components/viewport
forked from: https://github.com/charmbracelet/bubbles/blob/master/viewport/viewport.go
forked from: https://github.com/charmbracelet/bubbles/blob/master/viewport/viewport.go

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL