See here.
8 | 9 | 10 | -------------------------------------------------------------------------------- /backend/web/landing/www/install.py: -------------------------------------------------------------------------------- 1 | """ 2 | A small install script to download the correct hishtory binary for the current OS/architecture. 3 | The hishtory binary is in charge of installing itself, this just downloads the correct binary and 4 | executes it. 5 | """ 6 | 7 | import json 8 | import urllib.request 9 | import platform 10 | import sys 11 | import os 12 | 13 | def get_executable_tmpdir(): 14 | specified_dir = os.environ.get('TMPDIR', '') 15 | if specified_dir: 16 | return specified_dir 17 | try: 18 | if hasattr(os, 'ST_NOEXEC'): 19 | if os.statvfs("/tmp").f_flag & os.ST_NOEXEC: 20 | # /tmp/ is mounted as NOEXEC, so fall back to the current working directory 21 | return os.getcwd() 22 | except: 23 | pass 24 | return "/tmp/" 25 | 26 | with urllib.request.urlopen('https://api.hishtory.dev/api/v1/download') as response: 27 | resp_body = response.read() 28 | download_options = json.loads(resp_body) 29 | 30 | if platform.system() == 'Linux' and platform.machine() == "x86_64": 31 | download_url = download_options['linux_amd_64_url'] 32 | elif platform.system() == 'Linux' and platform.machine() == "aarch64": 33 | download_url = download_options['linux_arm_64_url'] 34 | elif platform.system() == 'Linux' and platform.machine() == "armv7l": 35 | download_url = download_options['linux_arm_7_url'] 36 | elif platform.system() == 'Darwin' and platform.machine() == 'arm64': 37 | download_url = download_options['darwin_arm_64_url'] 38 | elif platform.system() == 'Darwin' and platform.machine() == 'x86_64': 39 | download_url = download_options['darwin_amd_64_url'] 40 | else: 41 | print(f"No hishtory binary for system={platform.system()}, machine={platform.machine()}!\nIf you believe this is a mistake, please open an issue here: https://github.com/ddworken/hishtory/issues") 42 | sys.exit(1) 43 | 44 | with urllib.request.urlopen(download_url) as response: 45 | hishtory_binary = response.read() 46 | 47 | tmpFilePath = os.path.join(get_executable_tmpdir(), 'hishtory-client') 48 | if os.path.exists(tmpFilePath): 49 | os.remove(tmpFilePath) 50 | with open(tmpFilePath, 'wb') as f: 51 | f.write(hishtory_binary) 52 | os.system('chmod +x ' + tmpFilePath) 53 | cmd = tmpFilePath + ' install' 54 | if os.environ.get('HISHTORY_OFFLINE'): 55 | cmd += " --offline" 56 | additional_flags = [flag for flag in sys.argv[1:] if flag.startswith("-") and flag != "-" and flag != "--"] 57 | if additional_flags: 58 | cmd += " " + " ".join(additional_flags) 59 | exitCode = os.system(cmd) 60 | os.remove(tmpFilePath) 61 | if exitCode != 0: 62 | raise Exception("failed to install downloaded hishtory client via `" + tmpFilePath +" install` (is that directory mounted noexec? Consider setting an alternate directory via the TMPDIR environment variable)!") 63 | print('Succesfully installed hishtory! Open a new terminal, try running a command, and then running `hishtory query`.') 64 | -------------------------------------------------------------------------------- /client/cmd/configAdd.go: -------------------------------------------------------------------------------- 1 | package cmd 2 | 3 | import ( 4 | "fmt" 5 | "os" 6 | "strings" 7 | 8 | "github.com/ddworken/hishtory/client/hctx" 9 | "github.com/ddworken/hishtory/client/lib" 10 | 11 | "github.com/spf13/cobra" 12 | ) 13 | 14 | var configAddCmd = &cobra.Command{ 15 | Use: "config-add", 16 | Short: "Add a config option", 17 | GroupID: GROUP_ID_CONFIG, 18 | Run: func(cmd *cobra.Command, args []string) { 19 | lib.CheckFatalError(cmd.Help()) 20 | os.Exit(1) 21 | }, 22 | } 23 | 24 | var addCustomColumnsCmd = &cobra.Command{ 25 | Use: "custom-columns", 26 | Aliases: []string{"custom-column"}, 27 | Short: "Add a custom column", 28 | Args: cobra.ExactArgs(2), 29 | Run: func(cmd *cobra.Command, args []string) { 30 | columnName := args[0] 31 | command := args[1] 32 | ctx := hctx.MakeContext() 33 | config := hctx.GetConf(ctx) 34 | if config.CustomColumns == nil { 35 | config.CustomColumns = make([]hctx.CustomColumnDefinition, 0) 36 | } 37 | for _, existingColumn := range config.CustomColumns { 38 | if strings.EqualFold(existingColumn.ColumnName, columnName) { 39 | lib.CheckFatalError(fmt.Errorf("cannot create a column named %#v since there is already one named %#v", existingColumn.ColumnName, columnName)) 40 | } 41 | } 42 | config.CustomColumns = append(config.CustomColumns, hctx.CustomColumnDefinition{ColumnName: columnName, ColumnCommand: command}) 43 | lib.CheckFatalError(hctx.SetConfig(config)) 44 | }, 45 | } 46 | 47 | var addDisplayedColumnsCmd = &cobra.Command{ 48 | Use: "displayed-columns", 49 | Aliases: []string{"displayed-column"}, 50 | Short: "Add a column to be displayed", 51 | Args: cobra.ExactArgs(1), 52 | Run: func(cmd *cobra.Command, args []string) { 53 | ctx := hctx.MakeContext() 54 | config := hctx.GetConf(ctx) 55 | config.DisplayedColumns = append(config.DisplayedColumns, args...) 56 | lib.CheckFatalError(hctx.SetConfig(config)) 57 | }, 58 | } 59 | 60 | var addDefaultSearchColumnsCmd = &cobra.Command{ 61 | Use: "default-search-columns", 62 | Aliases: []string{"default-search-column"}, 63 | Short: "Add a column that is used for \"default\" search queries that don't use any search atoms", 64 | Long: "By default hishtory queries are checked against `command`, `current_working_directory`, and `hostname`. This option can be used to add additional columns to the list of columns checked in default queries. E.g. to add a custom column named `git_remote` to the list of default search columns, you would run `hishtory config-add default-search-columns git_remote`", 65 | Args: cobra.ExactArgs(1), 66 | Run: func(cmd *cobra.Command, args []string) { 67 | ctx := hctx.MakeContext() 68 | config := hctx.GetConf(ctx) 69 | lib.CheckFatalError(validateDefaultSearchColumns(ctx, args)) 70 | config.DefaultSearchColumns = append(config.DefaultSearchColumns, args...) 71 | lib.CheckFatalError(hctx.SetConfig(config)) 72 | }, 73 | } 74 | 75 | func init() { 76 | rootCmd.AddCommand(configAddCmd) 77 | configAddCmd.AddCommand(addCustomColumnsCmd) 78 | configAddCmd.AddCommand(addDisplayedColumnsCmd) 79 | configAddCmd.AddCommand(addDefaultSearchColumnsCmd) 80 | } 81 | -------------------------------------------------------------------------------- /client/cmd/enableDisable.go: -------------------------------------------------------------------------------- 1 | package cmd 2 | 3 | import ( 4 | "context" 5 | 6 | "github.com/ddworken/hishtory/client/hctx" 7 | "github.com/ddworken/hishtory/client/lib" 8 | 9 | "github.com/spf13/cobra" 10 | ) 11 | 12 | var enableCmd = &cobra.Command{ 13 | Use: "enable", 14 | Short: "Enable hiSHtory recording", 15 | GroupID: GROUP_ID_CONFIG, 16 | Run: func(cmd *cobra.Command, args []string) { 17 | ctx := hctx.MakeContext() 18 | lib.CheckFatalError(Enable(ctx)) 19 | }, 20 | } 21 | 22 | var disableCmd = &cobra.Command{ 23 | Use: "disable", 24 | Short: "Disable hiSHtory recording", 25 | GroupID: GROUP_ID_CONFIG, 26 | Run: func(cmd *cobra.Command, args []string) { 27 | ctx := hctx.MakeContext() 28 | lib.CheckFatalError(Disable(ctx)) 29 | }, 30 | } 31 | 32 | func Enable(ctx context.Context) error { 33 | config := hctx.GetConf(ctx) 34 | config.IsEnabled = true 35 | return hctx.SetConfig(config) 36 | } 37 | 38 | func Disable(ctx context.Context) error { 39 | config := hctx.GetConf(ctx) 40 | config.IsEnabled = false 41 | return hctx.SetConfig(config) 42 | } 43 | 44 | func init() { 45 | rootCmd.AddCommand(enableCmd) 46 | rootCmd.AddCommand(disableCmd) 47 | } 48 | -------------------------------------------------------------------------------- /client/cmd/export.go: -------------------------------------------------------------------------------- 1 | package cmd 2 | 3 | import ( 4 | "context" 5 | "encoding/json" 6 | "fmt" 7 | "io" 8 | "os" 9 | 10 | "github.com/ddworken/hishtory/client/data" 11 | "github.com/ddworken/hishtory/client/hctx" 12 | "github.com/ddworken/hishtory/client/lib" 13 | 14 | "github.com/spf13/cobra" 15 | ) 16 | 17 | var exportJsonCmd = &cobra.Command{ 18 | Use: "export-json", 19 | Short: "Export history entries formatted in JSON lines format (as accepted by hishtory import-json, and easily parsable by other tools)", 20 | GroupID: GROUP_ID_MANAGEMENT, 21 | Run: func(cmd *cobra.Command, args []string) { 22 | ctx := hctx.MakeContext() 23 | err := exportToJson(ctx, os.Stdout) 24 | lib.CheckFatalError(err) 25 | }, 26 | } 27 | 28 | func structToMap(entry data.HistoryEntry) (map[string]interface{}, error) { 29 | inrec, err := json.Marshal(entry) 30 | if err != nil { 31 | return nil, err 32 | } 33 | var m map[string]interface{} 34 | err = json.Unmarshal(inrec, &m) 35 | return m, err 36 | } 37 | 38 | func exportToJson(ctx context.Context, w io.Writer) error { 39 | db := hctx.GetDb(ctx) 40 | chunkSize := 1000 41 | offset := 0 42 | for { 43 | entries, err := lib.SearchWithOffset(ctx, db, "", chunkSize, offset) 44 | if err != nil { 45 | return fmt.Errorf("failed to search for history entries with offset=%d: %w", offset, err) 46 | } 47 | if len(entries) == 0 { 48 | break 49 | } 50 | for _, entry := range entries { 51 | if entry.Command == "" { 52 | // Skip empty commands, see https://github.com/ddworken/hishtory/issues/279 53 | continue 54 | } 55 | m, err := structToMap(*entry) 56 | if err != nil { 57 | return err 58 | } 59 | delete(m, "device_id") 60 | delete(m, "entry_id") 61 | j, err := json.Marshal(m) 62 | if err != nil { 63 | return err 64 | } 65 | _, err = w.Write(j) 66 | if err != nil { 67 | return err 68 | } 69 | _, err = w.Write([]byte("\n")) 70 | if err != nil { 71 | return err 72 | } 73 | } 74 | offset += chunkSize 75 | } 76 | return nil 77 | } 78 | 79 | func init() { 80 | rootCmd.AddCommand(exportJsonCmd) 81 | } 82 | -------------------------------------------------------------------------------- /client/cmd/install_test.go: -------------------------------------------------------------------------------- 1 | package cmd 2 | 3 | import ( 4 | "os" 5 | "path" 6 | "testing" 7 | 8 | "github.com/ddworken/hishtory/client/data" 9 | "github.com/ddworken/hishtory/client/hctx" 10 | "github.com/ddworken/hishtory/shared/testutils" 11 | 12 | "github.com/stretchr/testify/require" 13 | ) 14 | 15 | func TestSetup(t *testing.T) { 16 | defer testutils.BackupAndRestore(t)() 17 | defer testutils.RunTestServer()() 18 | 19 | homedir, err := os.UserHomeDir() 20 | require.NoError(t, err) 21 | if _, err := os.Stat(path.Join(homedir, data.GetHishtoryPath(), data.CONFIG_PATH)); err == nil { 22 | t.Fatalf("hishtory secret file already exists!") 23 | } 24 | require.NoError(t, setup("", false)) 25 | if _, err := os.Stat(path.Join(homedir, data.GetHishtoryPath(), data.CONFIG_PATH)); err != nil { 26 | t.Fatalf("hishtory secret file does not exist after Setup()!") 27 | } 28 | data, err := os.ReadFile(path.Join(homedir, data.GetHishtoryPath(), data.CONFIG_PATH)) 29 | require.NoError(t, err) 30 | if len(data) < 10 { 31 | t.Fatalf("hishtory secret has unexpected length: %d", len(data)) 32 | } 33 | config := hctx.GetConf(hctx.MakeContext()) 34 | if config.IsOffline != false { 35 | t.Fatalf("hishtory config should have been offline") 36 | } 37 | } 38 | 39 | func TestSetupOffline(t *testing.T) { 40 | defer testutils.BackupAndRestore(t)() 41 | defer testutils.RunTestServer()() 42 | 43 | homedir, err := os.UserHomeDir() 44 | require.NoError(t, err) 45 | if _, err := os.Stat(path.Join(homedir, data.GetHishtoryPath(), data.CONFIG_PATH)); err == nil { 46 | t.Fatalf("hishtory secret file already exists!") 47 | } 48 | require.NoError(t, setup("", true)) 49 | if _, err := os.Stat(path.Join(homedir, data.GetHishtoryPath(), data.CONFIG_PATH)); err != nil { 50 | t.Fatalf("hishtory secret file does not exist after Setup()!") 51 | } 52 | data, err := os.ReadFile(path.Join(homedir, data.GetHishtoryPath(), data.CONFIG_PATH)) 53 | require.NoError(t, err) 54 | if len(data) < 10 { 55 | t.Fatalf("hishtory secret has unexpected length: %d", len(data)) 56 | } 57 | config := hctx.GetConf(hctx.MakeContext()) 58 | if config.IsOffline != true { 59 | t.Fatalf("hishtory config should have been offline, actual=%#v", string(data)) 60 | } 61 | } 62 | -------------------------------------------------------------------------------- /client/cmd/reupload.go: -------------------------------------------------------------------------------- 1 | package cmd 2 | 3 | import ( 4 | "github.com/ddworken/hishtory/client/hctx" 5 | "github.com/ddworken/hishtory/client/lib" 6 | 7 | "github.com/spf13/cobra" 8 | ) 9 | 10 | var reuploadCmd = &cobra.Command{ 11 | Use: "reupload", 12 | Hidden: true, 13 | Short: "[Debug Only] Reupload your entire hiSHtory to all other devices", 14 | Run: func(cmd *cobra.Command, args []string) { 15 | lib.CheckFatalError(lib.Reupload(hctx.MakeContext())) 16 | }, 17 | } 18 | 19 | func init() { 20 | rootCmd.AddCommand(reuploadCmd) 21 | } 22 | -------------------------------------------------------------------------------- /client/cmd/root.go: -------------------------------------------------------------------------------- 1 | /* 2 | Copyright © 2022 NAME HEREYour shell history in context, synced, and queryable
6 || {{ . }} | 44 | {{ end }} 45 |
|---|
| {{ . }} | 52 | {{ end }} 53 |