* Add delimiters to screen tab, make active gradient a translucent mask
* make delimiter slightly shorter
* move end icon a bit to provide more separation
* fix zindex for tab contents
* fix magic layout
* make the tabs closer to the width they used to be
* termfontsize-sm (for meta1). add some small margin. remove rootIndicator. switch cwd/remote to red if root
* break LineHeader out into its own react component
* actual set our --term colors as the *theme* for xtermjs
* move line-actions into its own div (absolute position). hover/background colors
* add duration, format renderer, spacing, remove meta-wrap
* simplify cmdtext output. simpler multi-line rendering.
* adjust position/height of line actions for better interaction with long lines
* fix horiz scrolling
* remove unused
* quick fix for text lines
* remove [local] from prompt, remove prompt icons, restore --term vars (remove --prompt vars)
* working on prompt colors, cmdtext
* more generous padding around commands (and cmdinput)
* fix cmdinput background color
* fixes for cmdinput info box
* Fix logo not being visible in auxiliary views when sidebar is collapsed
* Refactor auxiliary views into MainView component
* fix contents formatting
* Need a better-centered version of the logo for the sidebar
* Add logo back to the sidebar
* revert root.less change
* Fix regressions from last pr
* zero out subtractor if sidebar is collapsed
* remove unnecessary var
* clean up emain
* add restart on disable auto update
* save work
* add zip
* save
* fix zip command
* make build-universal more generic
* clean up script
* fix autoupdate config
* update feed
* fix update feed path
* switch to custom update flow
* show notification
* remove enum
* test change
* debug sidebar
* save work
* remove weird import
* remove listeners if present
* save debug
* fixed banner
* fix sending of appupdatestatus, add comments
* Change to primary feed
* more comments, less debugs
* rename to app update
* code cleanup, add fireAndForget
* update paths for objects
Electron version 28.1.2 introduced a bug where the traffic light to undo
fullscreen was not available in fullscreen. It has been fixed by the
most recent version, so we are upgrading to it.
* MonoFontSize type, add label font, theme vars for sidebar
* fix line-height for tabs
* experiment with variable label font
* lato font, fix open ai fonts, fix cmdinput font
* updates for historyinfo
* cmdinput history fixups, scrollbars
* work with scrollbars
* create another drag region at the end of the tabs bar
* updates for header -- change title drag area, fix corner rounding, tabs spacing, etc.
* css variables for sidebar
* type
* line css vars
* lines css vars
* bookmarks css vars
* clientsettings css vars
* button.less css vars
* checkbox.less css vars
* cmdstrcode.less css vars
* dropdown.less css vars
* markdown css vars
* status css vars
* convert all hex colors to rgb color
* textfield css vars
* toggle css vars
* tooltip css vars
* statusindicator css vars
* about modal css vars
* disconnected modal css vars
* editremoteconn modal css vars
* linesettings modal css vars
* tos modal css vars
* viewremoteconndetail modal css vars
* prompt css vars
* connections view css vars
* add colors comments
* history view css vars
* cmdinput css vars
* cmdinput css vars
* screenview css vars
* convert less vars to css vars
* store version for build in txt file
* get version from version.txt
* remove quotes
* Use version.js for Go version too
* test
* test
* simplify things more
* rename zips to consistent waveterm name
* remove newline
* always use v
* always use Wave rather than waveterm
* undo awkward backgrounds, transparencies, etc. hope to sharpen up the active blocks and the grey/transparent backgrounds were getting in the way
* block UI and cmdinput UI overhaul
* updates for cmdinput spacing, input-sep fonts
* remove nth-child special case, fix sidebar margins
* sidebar styles
* bring back selected line
* codeedit fixes for layout / colors
* Set build version programmatically in build-helper
* remove env var definition
* fix paths in helper scripts
* missing import
* missed some more relative paths
* reorganize line styles, split lines.less into lines.less and line.less
* switch everyone to use termFontSize getter (easier to find usages)
* better font-family font-size update logic
* update line styles, clean up more
* replace icons, fix line heights
* make paddings/margins more consistent
* fix more margins, make command completions use termfontfamily
* updates for cmdinput margins, font sizes, etc.
* fix more font sizes and margins (mostly command input)
* add comment
* testing hack font
* updates to allow font to be variable
* allow setting of font-family. get initial font family from electron (needed for loading)
* add termfontfamily
* update wave logos for README
* hook up fontfamily setting, remove old dropdown active var
* get app to reload on font change. reload fonts
* on termfontsize change, bump render version as well
* font loading fix#302
* fix inconsistent paddings. issue was that the first '[' feels indented (because of the fixed with font). applying a negative 2px margin fixes it and allows us to remove the paddings on the other elements.
* Break update code out of sstore
* add license disclaimers
* missed one
* add another
* fix regression in openai updates, remove unnecessary functions
* another copyright
* update casts
* fix issue with variadic updates
* remove logs
* remove log
* remove unnecessary log
* save work
* moved a bunch of stuff to scbus
* make modelupdate an object
* fix new screen not updating active screen
* add comment
* make updates into packet types
* different cast
* update comments, remove unused methods
* add one more comment
* add an IsEmpty() on model updates to prevent sending empty updates to client
* feat: parse multiple identity files in ssh
While this does not make it possible to discover multiple identity files
in every case, it does make it possible to parse them individually and
check for user input if it's required for each one.
* chore: remove unnecessary print in updatebus.go
* chore: remove unnecessary print in sshclient.go
* chore: remove old publicKey auth check
With the new callback in place, we no longer need this, so it has been
removed.
* refactor: move logic for wave and config options
The logic for making decisions between details made available from wave
and details made available from ssh_config was spread out. This change
condenses it into one function for gathering those details and one for
picking between them.
It also adds a few new keywords but the logic for those hasn't been
implemented yet.
* feat: allow attempting auth methods in any order
While waveterm does not provide the control over which order to attempt
yet, it is possible to provide that information in the ssh_config. This
change allows that order to take precedence in a case where it is set.
* feat: add batch mode support
BatchMode turns off user input to enter passwords for ssh. Because we
save passwords, we can still attempt these methods but we disable the
user interactive prompts in this case.
* fix: fix auth ordering and identity files
The last few commits introduced a few bugs that are fixed here. The
first is that the auth ordering is parsed as a single string and not a
list. This is fixed by manually splitting the string into a list. The
second is that the copy of identity files was not long enough to copy
the contents of the original. This is now updated to use the length of
the original in its construction.
* deactivate timer while connecting to new ssh
The new ssh setup handles timers differently from the old one due to the
possibility of asking for user input multiple times. This limited the
user input to entirely be done within 15 seconds. This removes that
restriction which will allow those timers to increase. It does not
impact the legacy ssh systems or the local connections on the new
system.
* merge branch 'main' into 'ssh--auth-control'
This was mostly straightforward, but it appears that a previous commit
to main broke the user input modals by deleting a function. This adds
that back in addition to the merge.
* fix: allow 60 second timeouts for ssh inputs
With the previous change, it is now possible to extend the timeout for
manual inputs. 60 seconds should be a reasonable starting point.
* fix: change size of dummy key to 2048
This fixes the CodeQL scan issue for using a weak key.
* working on easy global shortcut for wave
* globalshortcut setting working
* cmd for macos, alt for others
* re-remove types.ts (was added back during merge)
* rename DDItem to DropdownItem, put into custom.d.ts
* make some consts
* declare types as global
* remove mobx types aliases
* put back model_old.ts
* remove types.ts
* add main screens to Cmd-P search
* make viewData optional
* minor hint fix
* address improvements suggested by evan
* more on let to const
This PR changes ModelUpdate mechanism from a statically-typed struct to an interface, allowing us to define the update mechanism and the update types separately. This sets us up to move app logic and update mechanisms into separate packages. Ultimately, sstore will only define low-level persistence logic.
* feat: create backend for user input requests
This is the first part of a change that allows the backend to request
user input from the frontend. Essentially, the backend will send a
request for the user to answer some query, and the frontend will send
that answer back. It is blocking, so it needs to be used within a
goroutine.
There is some placeholder code in the frontend that will be updated in
future commits. Similarly, there is some debug code in the backend
remote.go file.
* feat: create frontend for user input requests
This is part of a change to allow the backend to request user input from
the frontend. This adds a component specifically for handling this
logic. It is only a starting point, and does not work perfectly yet.
* refactor: update user input backend/interface
This updates the user input backend to fix a few potential bugs. It also
refactors the user input request and response types to better handle
markdown and errors while making it more convenient to work with.
A couple frontend changes were made to keep everything compatible.
* fix: add props to user input request modal
There was a second place that the modals were created that I previously
missed. This fixes that second casel
* feat: complete user input modal
This rounds out the most immediate concerns for the new user input
modal. The frontend now includes a timer to show how much time is left
and will close itself once it reaches zero. Css
formatting has been cleaned up to be more reasonable.
There is still some test code present on the back end. This will be
removed once actuall examples of the new modal are in place.
* feat: create first pass known_hosts detection
Manually integrating with golang's ssh library means that the code must
authenticate known_hosts on its own. This is a first pass at creating a
system that parses the known hosts files and denys a connection if there
is a mismatch. This needs to be updated with a means to add keys to the
known-hosts file if the user requests it.
* feat: allow writing to known_hosts first pass
As a follow-up to the previous change, we now allow the user to respond
to interactive queries in order to determine if an unknown known hosts
key can be added to a known_hosts file if it is missing. This needs to
be refined further, but it gets the basic functionality there.
* feat: add user input for kbd-interactive auth
This adds a modal so the user can respond to prompts provided using the
keyboard interactive authentication method.
* feat: add interactive password authentication
This makes the ssh password authentication interactive with its own user
input modal. Unfortunately, this method does not allow trying a default
first. This will need to be expanded in the future to accomodate that.
* fix: allow automatic and interactive auth together
Previously, it was impossible to use to separate methods of the same
type to try ssh authentication. This made it impossible to make an auto
attempt before a manual one. This change restricts that by combining
them into one method where the auto attempt is tried once first and
cannot be tried again. Following that, interactive authentication can be
tried separately.
It also lowers the time limit on kbd interactive authentication to 15
seconds due to limitations on the library we are using.
* fix: set number of retries to one in ssh
Number of retries means number of attempts after the fact, not number of
total attempts. It has been adjusted from 2 to 1 to reflect this.
* refactor: change argument order in GetUserInput
This is a simple change to move the context to the first argument of
GetUserInput to match the convention used elsewhere in the code.
* fix: set number of retries to two again
I was wrong in my previous analysis. The number given is the total
number of tries. This is confusing when keyboard authentication and
password authentication are both available which usually doesn't happen.
* feat: create naive ui for ssh key passphrases
This isn't quite as reactive as the other methods, but it does attempt
to use publickey without a passphrase, then attempt to use the password
as the passphrase, and finally prompting the user for a passphrase. The
problem with this approach is that if multiple keys are used and they
all have passphrases, they need to all be checked up front. In practice,
this will not happen often, but it is something to be aware of.
* fix: add the userinput.tsx changes
These were missed in the previous commit. Adding them now.
* split settings modals
* init
* init
* remove styles not related to checkbox
* remove styles not related to CmdStrCode
* renderCmdText doesn't need styles
* remove styles not related to dropdown
* IconButton doesn't need styles because it extends Button
* remove old connections
* InfoMessage conmponent no longer needed
* fix import error
* remove styles not related to InlineSettingsTextEdit
* remove styles not related to InputDecoration
* LinkButton doesn't need styles cos it's extends Button component
* remove styles not related to markdown
* remove styles not related to modal
* NumberField doesn't need styles cos it extends TextField
* remove styles not related to PasswordField
* RemoteStatusLight no longer used. It's replaced by Status component.
* remove styles not related to ResizableSidebar
* SettingsError doesn't need styles cos it uses classnames in app.less
* remove styles not related to Status
* remove styles not related to TextField
* remove styles not related to Toggle
* remove styles not related to Tooltip
* init
* cleanup bookmarks model
* cleanup clientsettingsview model
* cleanup cmd model
* remove dayjs import from bookmarks model
* cleanup commandrunner model
* cleanup historyview model
* cleanup input model
* cleanup linecontainer model
* cleanup mainsidebar model
* cleanup main model
* cleanup plugins model
* cleanup remote model
* cleanup screen model
* cleanup screenlines model
* cleanup session model
* cleanup screenlinecontainer model
* cleanup connectionsview model
* add index.ts inside model dir
* replace /model_old imports with /model
* rename model to models
* move model_old to models
* fix ptyDataSource errors
* split models/model
* first pass of copy file
* first pass fixing up function
* fleshed out copy function, still working on display and parameters
* implemented scp like syntax
* finished implemententation of copy file - there are still issues
* more bug fixes, still running into error
* pushing waveshell concurrency and channel fixes - still need to do some qol fixes before merge
* aesthetic fixes and removed logs
* fixed bug in GetRemoteRuntimeState
* formatting small fix
* fixed pretty print bytes
* added local to local command
* small fix removing workaround
* added workaround back
* added some logs for debug
* added some more logs
* quick bug fix for update cmd race condition
* added fix for race condition
* added some more logs for debugging
* fixed up logs
* added proper fe state for dest parameter
* implemented setting status indicator output
* first pass at updating status indicators
* removed logs and small fix ups
* removed whitespace
* addressed review comments
* split settings modals
* init
* init
* remove styles not related to checkbox
* remove styles not related to CmdStrCode
* renderCmdText doesn't need styles
* remove styles not related to dropdown
* IconButton doesn't need styles because it extends Button
* remove old connections
* InfoMessage conmponent no longer needed
* fix import error
* remove styles not related to InlineSettingsTextEdit
* remove styles not related to InputDecoration
* LinkButton doesn't need styles cos it's extends Button component
* remove styles not related to markdown
* remove styles not related to modal
* NumberField doesn't need styles cos it extends TextField
* remove styles not related to PasswordField
* RemoteStatusLight no longer used. It's replaced by Status component.
* remove styles not related to ResizableSidebar
* SettingsError doesn't need styles cos it uses classnames in app.less
* remove styles not related to Status
* remove styles not related to TextField
* remove styles not related to Toggle
* remove styles not related to Tooltip
* wip
* integrate original sidebar content
* ResizableSidebar component
* trigger toggleCollapse
* remove debugging code
* minor refactor. disable text select on mousemove
* replace icons with fontawesome icons. fix alignment issues
* fix session view width when tabs overflow
* prevent index and icon from shifting when resizing
* snap effect
* minor refactor
* apply collapsed mode to sidebar contents
* change default width to 240px
* backend implementation
* fix wrong subcmd
* save collapsed state
* retore sidebar state on reload/launch
* use collapse data form db on first load. use previously saved width on expand.
* persist width as well collapse state
* various fixes and improvements
* bind methods
* refactor
* more refactor
* fix minor bug
* fix merge issues
* various fixes
* refactor
* fixes
* fix issues
* fix all issues
* resolve undefind tempWidth
* fix toggleCollapsed
* use Promise in stopResizing method
* use tempCollapsed to for real time toggling between logos
* minor method name change
* refactor
* remove debugging code
* fix conflict
* fix setting collapsed state via CLI
* minor refactor
* remove debugging code
* create setTempWidthAndTempCollapsed method
* handle invalid width set via cli
* refactor: setbycli not actually needed
* remove unused code
* add status-indicator-visible
* save
* save
* Prevent the status indicator flickering for quick returns
* flx regression
* reduce delay, reset spinnerVisible when there's no more running commands
* clean up code reuse
* move code around
* slight optimizations to prevent rendering before spinner is visible
* rename var
* revert shouldSync change as it broke the sync
* set animation startTime to sync spinners for status indicators
* catch animationstart (hover interaction) to restart startTime.
* use const
---------
Co-authored-by: Evan Simkowitz <esimkowitz@users.noreply.github.com>
# Use only 'java-kotlin' to analyze code written in Java, Kotlin or both
# Use only 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both
# Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
steps:
- name:Checkout repository
uses:actions/checkout@v3
steps:
- name:Checkout repository
uses:actions/checkout@v4
# Initializes the CodeQL tools for scanning.
- name:Initialize CodeQL
uses:github/codeql-action/init@v3
with:
languages:${{ matrix.language }}
# If you wish to specify custom queries, you can do so here or in a config file.
# By default, queries listed here will override any specified in a config file.
# Prefix the list here with "+" to use these queries and those in the config file.
# Initializes the CodeQL tools for scanning.
- name:Initialize CodeQL
uses:github/codeql-action/init@v3
with:
languages:${{ matrix.language }}
# If you wish to specify custom queries, you can do so here or in a config file.
# By default, queries listed here will override any specified in a config file.
# Prefix the list here with "+" to use these queries and those in the config file.
# For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
# queries: security-extended,security-and-quality
# For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
# queries: security-extended,security-and-quality
# Autobuild attempts to build any compiled languages (C/C++, C#, Go, Java, or Swift).
# If this step fails, then you should remove it and run the build manually (see below)
- name:Autobuild
uses:github/codeql-action/autobuild@v3
# Autobuild attempts to build any compiled languages (C/C++, C#, Go, Java, or Swift).
# If this step fails, then you should remove it and run the build manually (see below)
- name:Autobuild
uses:github/codeql-action/autobuild@v3
# ℹ️ Command-line programs to run using the OS shell.
# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
# ℹ️ Command-line programs to run using the OS shell.
# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
# If the Autobuild fails above, remove it and uncomment the following three lines.
# modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
# If the Autobuild fails above, remove it and uncomment the following three lines.
# modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
These instructions are for setting up the build on MacOS.
These instructions are for setting up the build on MacOS.
If you're developing on Linux please use the [Linux Build Instructions](./build-linux.md).
## Running the Development Version of Wave
If you install the production version of Wave, you'll see a semi-transparent sidebar, and the data for Wave is stored in the directory ~/.waveterm. The development version has a blue sidebar and stores its data in ~/.waveterm-dev. This allows the production and development versions to be run simultaneously with no conflicts. If the dev database is corrupted by development bugs, or the schema changes in development it will not affect the production copy.
If you install the production version of Wave, you'll see a semi-transparent gray sidebar, and the data for Wave is stored in the directory ~/.waveterm. The development version has a blue sidebar and stores its data in ~/.waveterm-dev. This allows the production and development versions to be run simultaneously with no conflicts. If the dev database is corrupted by development bugs, or the schema changes in development it will not affect the production copy.
## Prereqs and Tools
Download and install Go (must be at least go 1.18):
```
brew install go
```
Download and install ScriptHaus (to run the build commands):
```
brew tap scripthaus-dev/scripthaus
brew install scripthaus
```
You also need a relatively modern nodejs with npm and yarn installed.
* Node can be installed from [https://nodejs.org](https://nodejs.org).
* npm can install yarn using:
-Node can be installed from [https://nodejs.org](https://nodejs.org).
This builds the Golang backends for Wave. The binaries will put in waveshell/bin and wavesrv/bin respectively. If you're working on a new plugin or other pure frontend changes to Wave, you won't need to rebuild these unless you pull new code from the Wave Repository.
This builds the Golang backends for Wave. The binaries will put in waveshell/bin and wavesrv/bin respectively. If you're working on a new plugin or other pure frontend changes to Wave, you won't need to rebuild these unless you pull new code from the Wave Repository.
## One-Time Setup
Install modules (we use yarn):
```
yarn
```
Electron also requires specific builds of node_modules to work (because Electron embeds a specific node.js version that might not match your development node.js version). We use a special electron command to cross-compile those modules:
Electron also requires specific builds of node_modules to work (because Electron embeds a specific node.js version that might not match your development node.js version). We use a special electron command to cross-compile those modules:
```
scripthaus run electron-rebuild
@@ -57,7 +61,7 @@ scripthaus run electron-rebuild
## Running WebPack
We use webpack to build both the React and Electron App Wrapper code. They are both run together using:
We use webpack to build both the React and Electron App Wrapper code. They are both run together using:
```
scripthaus run webpack-watch
@@ -65,15 +69,16 @@ scripthaus run webpack-watch
## Running the WaveTerm Dev Client
Now that webpack is running (and watching for file changes) we can finally run the WaveTerm Dev Client! To start the client run:
Now that webpack is running (and watching for file changes) we can finally run the WaveTerm Dev Client! To start the client run:
```
scripthaus run electron
```
To kill the client, either exit the Electron App normally or just Ctrl-C the ```scripthaus run electron``` command.
To kill the client, either exit the Electron App normally or just Ctrl-C the `scripthaus run electron` command.
Because we're running webpack in watch mode, any changes you make to the typescript will be automatically picked up by the client after a refresh. Note that I've disabled hot-reloading in the webpack config, so to pick up new changes you'll have to manually refresh the WaveTerm Client window. To do that use "Command-Shift-R" (Command-R is used internally by WaveTerm and will not force a refresh).
Because we're running webpack in watch mode, any changes you make to the typescript will be automatically picked up by the client after a refresh. Note that I've disabled hot-reloading in the webpack config, so to pick up new changes you'll have to manually refresh the WaveTerm Client window. To do that use "Option-R" (Command-R is used internally by WaveTerm and will not force a refresh).
## Debugging the Dev Client
You can use the regular Chrome DevTools to debug the frontend application. You can open the DevTools using the keyboard shortcut `Cmd-Option-I`.
You can use the regular Chrome DevTools to debug the frontend application. You can open the DevTools using the keyboard shortcut `Cmd-Option-I`.
A open-source, cross-platform, modern terminal for seamless workflows.
A open-source, cross-platform, AI-integrated, modern terminal for seamless workflows.
Wave isn't just another terminal emulator; it's a rethink on how terminals are built. Wave combines command line with the power of the open web to help veteran CLI users and new developers alike.
Wave isn't just another terminal emulator; it's a rethink on how terminals are built. Wave combines command line with the power of the open web to help veteran CLI users and new developers alike.
* Inline renderers to cut down on context switching. Render code, images, markdown, and CSV files without ever leaving the terminal.
* Persistent sessions that can restore state across network disconnections and reboots
* Searchable contextual command history across all remote sessions (saved locally)
* Workspaces, tabs, and command blocks to keep you organized
- Inline renderers to cut down on context switching. Render code, images, markdown, and CSV files without ever leaving the terminal.
- Persistent sessions that can restore state across network disconnections and reboots
- Searchable contextual command history across all remote sessions (saved locally)
- Workspaces, tabs, and command blocks to keep you organized
- AI Integration with ChatGPT (or ChatGPT compatible APIs) to help write commands and get answers inline
These instructions are for setting up the build on Linux (Ubuntu).
These instructions are for setting up the build on Linux (Ubuntu).
If you're developing on MacOS please use the [MacOS Build Instructions](./BUILD.md).
If you are working on a different Linux distribution, you may need to adapt some of these instructions to fit your environment.
## Running the Development Version of Wave
If you install the production version of Wave, you'll see a semi-transparent sidebar, and the data for Wave is stored in the directory ~/prompt. The development version has a red/brown sidebar and stores its data in ~/prompt-dev. This allows the production and development versions to be run simultaneously with no conflicts. If the dev database is corrupted by development bugs, or the schema changes in development it will not affect the production copy.
If you install the production version of Wave, you'll see a semi-transparent gray sidebar, and the data for Wave is stored in the directory ~/.waveterm. The development version has a blue sidebar and stores its data in ~/.waveterm-dev. This allows the production and development versions to be run simultaneously with no conflicts. If the dev database is corrupted by development bugs, or the schema changes in development it will not affect the production copy.
## Prereqs and Tools
Download and install Go (must be at least go 1.18). We also need gcc installed to run a CGO build (for Golang).
Download and install Go (must be at least go 1.18). We also need gcc installed to run a CGO build (for Golang).
zip is required to build linux deployment packages (not required for running and debugging dev builds).
We use [nvm](https://github.com/nvm-sh/nvm) to install nodejs on Linux (you can use an alternate installer if you wish). You must have a relatively recent version of node in order to build the terminal. Different distributions and shells will require different setup instructions. These instructions work for Ubuntu 22 using bash (will install node v20.8.1):
We use [nvm](https://github.com/nvm-sh/nvm) to install nodejs on Linux (you can use an alternate installer if you wish). You must have a relatively recent version of node in order to build the terminal. Different distributions and shells will require different setup instructions. These instructions work for Ubuntu 22 using bash (will install node v20.8.1):
Electron also requires specific builds of node_modules to work (because Electron embeds a specific node.js version that might not match your development node.js version). We use a special electron command to cross-compile those modules:
Electron also requires specific builds of node_modules to work (because Electron embeds a specific node.js version that might not match your development node.js version). We use a special electron command to cross-compile those modules:
```
scripthaus run electron-rebuild
@@ -81,12 +81,11 @@ cd waveterm
scripthaus run build-backend
```
This builds the Golang backends for Wave. The binaries will put in waveshell/bin and wavesrv/bin respectively. If you're working on a new plugin or other pure frontend changes to Wave, you won't need to rebuild these unless you pull new code from the Wave Repository.
This builds the Golang backends for Wave. The binaries will put in waveshell/bin and wavesrv/bin respectively. If you're working on a new plugin or other pure frontend changes to Wave, you won't need to rebuild these unless you pull new code from the Wave Repository.
## Running WebPack
We use webpack to build both the React and Electron App Wrapper code. They are both run together using:
We use webpack to build both the React and Electron App Wrapper code. They are both run together using:
```
scripthaus run webpack-watch
@@ -94,15 +93,16 @@ scripthaus run webpack-watch
## Running the WaveTerm Dev Client
Now that webpack is running (and watching for file changes) we can finally run the WaveTerm Dev Client! To start the client run:
Now that webpack is running (and watching for file changes) we can finally run the WaveTerm Dev Client! To start the client run:
```
scripthaus run electron
```
To kill the client, either exit the Electron App normally or just Ctrl-C the ```scripthaus run electron``` command.
To kill the client, either exit the Electron App normally or just Ctrl-C the `scripthaus run electron` command.
Because we're running webpack in watch mode, any changes you make to the typescript will be automatically picked up by the client after a refresh. Note that I've disabled hot-reloading in the webpack config, so to pick up new changes you'll have to manually refresh the WaveTerm Client window. To do that use "Command-Shift-R" (Command-R is used internally by Wave and will not force a refresh).
Because we're running webpack in watch mode, any changes you make to the typescript will be automatically picked up by the client after a refresh. Note that I've disabled hot-reloading in the webpack config, so to pick up new changes you'll have to manually refresh the WaveTerm Client window. To do that use "Command-Shift-R" (Command-R is used internally by Wave and will not force a refresh).
## Debugging the Dev Client
You can use the regular Chrome DevTools to debug the frontend application. You can open the DevTools using the keyboard shortcut `Cmd-Option-I`.
You can use the regular Chrome DevTools to debug the frontend application. You can open the DevTools using the keyboard shortcut `Cmd-Option-I`.
spctl -a -vvv -t install $TEMP_WAVE_DIR_UNIVERSAL/
rm -rf $TEMP_DIR$ZIP_DIR
Some files were not shown because too many files have changed in this diff
Show More
Reference in New Issue
Block a user
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.